ปรับเปลี่ยนการเรียกเก็บเงิน

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X.
ข้อมูล

บทนำ

การสร้างรายได้ช่วยให้คุณสามารถปรับเปลี่ยนรายละเอียดสำหรับการเรียกเก็บเงินได้ ตัวอย่างเช่น คุณอาจต้องการ เพิ่มหรือลดส่วนแบ่งรายได้หรือค่าธรรมเนียมในเดือนที่เรียกเก็บเงินหนึ่งๆ เนื่องจาก ที่ไม่ตรงกันในบันทึกของคุณ

การสำรวจหน้าการแก้ไขการเรียกเก็บเงิน

ไปที่หน้าการแก้ไขการเรียกเก็บเงินตามที่อธิบายไว้ด้านล่าง

Edge

วิธีเข้าถึงหน้าการแก้ไขการเรียกเก็บเงินโดยใช้ Edge UI

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกเผยแพร่ > การสร้างรายได้ > การแก้ไขการเรียกเก็บเงินในแถบนำทางด้านซ้าย

หน้าการแก้ไขการเรียกเก็บเงินจะปรากฏขึ้น

ตามที่ไฮไลต์ในรูป หน้าการแก้ไขการเรียกเก็บเงินช่วยให้คุณสามารถทำสิ่งต่อไปนี้

คลาสสิก Edge (Private Cloud)

วิธีเข้าถึงหน้าการแก้ไขการเรียกเก็บเงินโดยใช้ Edge UI แบบคลาสสิก

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือ ที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
  2. เลือกการสร้างรายได้ > การปรับเปลี่ยนในแถบนำทางด้านบน

หน้าการแก้ไขการเรียกเก็บเงินช่วยให้คุณทำสิ่งต่อไปนี้ได้

  • ดูรายการแก้ไขการเรียกเก็บเงินปัจจุบัน
  • เพิ่มการแก้ไขการเรียกเก็บเงิน
  • แก้ไขการแก้ไขการเรียกเก็บเงิน
  • ค้นหารายการการแก้ไขการเรียกเก็บเงิน

เพิ่มการแก้ไขการเรียกเก็บเงิน

วิธีการเพิ่มการแก้ไขการเรียกเก็บเงิน

  1. เข้าถึงหน้าการแก้ไขการเรียกเก็บเงิน
  2. คลิก + การปรับปรุง
  3. ป้อนข้อมูลต่อไปนี้
    ช่อง รายละเอียด
    ชื่อ

    ชื่อที่สื่อความหมายซึ่งจะปรากฏในเอกสารการเรียกเก็บเงิน

    % การปรับค่าใช้จ่าย

    จำนวนการปรับค่าใช้จ่ายเป็นเปอร์เซ็นต์บวกหรือลบ ผลบวก เปอร์เซ็นต์จะปรับส่วนแบ่งรายได้หรือค่าธรรมเนียมในธุรกรรมตามนั้น เปอร์เซ็นต์ การปรับค่าใช้จ่ายติดลบจะปรับส่วนแบ่งรายได้หรือค่าธรรมเนียมใน ตามเปอร์เซ็นต์นั้น ป้อนเลขฐานสิบบวกหรือลบ (มีมากกว่า ทศนิยม 2 ตำแหน่ง)

    เดือนที่เรียกเก็บเงิน

    เดือนที่เรียกเก็บเงินสำหรับการปรับค่าใช้จ่าย เลือกเดือนจากรายการแบบเลื่อนลง

    ประเภทธุรกรรม

    ประเภทธุรกรรมที่คุณต้องการใช้การปรับค่าใช้จ่าย เลือก จากเมนูแบบเลื่อนลง

    • ธุรกรรมทั้งหมด
    • การเรียกเก็บเงิน (การเรียกเก็บเงินธุรกรรมโมเดล)
    • การซื้อ (ธุรกรรมรูปแบบส่วนแบ่งรายได้)
    • การคืนเงิน (ธุรกรรมรูปแบบส่วนแบ่งรายได้)
    ผลิตภัณฑ์

    ผลิตภัณฑ์ API ที่คุณต้องการใช้การปรับ คุณใช้ การปรับเปลี่ยนผลิตภัณฑ์ API หลายรายการ หากคุณต้องการใช้การปรับเปลี่ยนกับ API หลายรายการ ให้สร้างการปรับเปลี่ยนสำหรับแต่ละผลิตภัณฑ์ เลือกผลิตภัณฑ์ API จากเมนูแบบเลื่อนลง

    นักพัฒนาซอฟต์แวร์

    นักพัฒนาแอปที่คุณต้องการใช้การปรับค่าใช้จ่าย คุณสามารถใช้ ปรับเป็นนักพัฒนาซอฟต์แวร์ทุกราย (โดยค่าเริ่มต้น) หรือเฉพาะนักพัฒนาซอฟต์แวร์หนึ่งๆ เลือก "ทั้งหมด นักพัฒนาซอฟต์แวร์" หรือนักพัฒนาซอฟต์แวร์คนใดคนหนึ่งจากเมนูแบบเลื่อนลง

  4. คลิกสร้างการปรับ

การแก้ไขการแก้ไขการเรียกเก็บเงิน

วิธีแก้ไขการแก้ไขการเรียกเก็บเงิน

  1. เข้าถึงหน้าการแก้ไขการเรียกเก็บเงิน
  2. วางเคอร์เซอร์ไว้เหนือการแก้ไขการเรียกเก็บเงินที่ต้องการแก้ไข แล้วคลิก ในเมนูการทำงาน
  3. อัปเดตการแก้ไขการเรียกเก็บเงินตามที่จำเป็น
  4. คลิกอัปเดตการปรับ

การแก้ไขการเรียกเก็บเงินโดยใช้ API

ส่วนต่อไปนี้จะอธิบายวิธีแก้ไขการเรียกเก็บเงินโดยใช้ API

การแก้ไขการเรียกเก็บเงินโดยใช้ API

คุณสามารถปรับรายละเอียดสำหรับการเรียกเก็บเงินได้โดยการส่งคำขอ POST เพื่อ /organizations/{org_name}/billing-adjustments. เมื่อคุณส่งคำขอ คุณต้องระบุในช่อง เนื้อหาคำขอ:

  • ชื่อของการแก้ไขการเรียกเก็บเงิน
  • เปอร์เซ็นต์การปรับเปลี่ยน ซึ่งก็คือค่าเปอร์เซ็นต์บวกหรือค่าลบที่ เพิ่มหรือลดการเรียกเก็บเงินตามลำดับ
  • เดือนที่เรียกเก็บเงิน
  • ปีที่เรียกเก็บเงิน
  • องค์กรที่มีการปรับค่าใช้จ่ายการเรียกเก็บเงิน

นอกจากนี้ คุณยังระบุพร็อพเพอร์ตี้อื่นๆ ได้ด้วย เช่น

  • ประเภทธุรกรรมที่คุณต้องการใช้การปรับค่าใช้จ่าย (เช่น การซื้อ ธุรกรรม)
  • นักพัฒนาแอปที่คุณต้องการใช้การปรับค่าใช้จ่าย
  • คุณจะใช้การปรับเปลี่ยนกับนักพัฒนาซอฟต์แวร์ที่ชำระเงินล่วงหน้า นักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลัง หรือ ทั้ง 2 อย่าง
  • แพ็กเกจ API ที่คุณต้องการใช้การปรับ
  • ผลิตภัณฑ์ API ที่คุณต้องการใช้การปรับ

โปรดดูที่การตั้งค่ากำหนดการแก้ไขการเรียกเก็บเงินสำหรับรายการทั้งหมดของ พร็อพเพอร์ตี้การแก้ไขการเรียกเก็บเงินที่คุณระบุในคำขอปรับค่าใช้จ่ายได้

หากไม่ได้ระบุคุณสมบัติที่ไม่บังคับ การปรับค่าใช้จ่ายในเอกสารการเรียกเก็บเงินจะเป็นทั้งหมด สำหรับที่พักนั้นๆ ด้วย ตัวอย่างเช่น ถ้าไม่มีการระบุประเภทธุรกรรมไว้ การเรียกเก็บเงิน จะมีผลกับธุรกรรมทุกประเภท

ตัวอย่างต่อไปนี้ปรับเปลี่ยนการเรียกเก็บเงินสำหรับเดือนที่เรียกเก็บเงินที่ยังไม่เปิดทำการ มิถุนายน 2013 การปรับเปลี่ยนช่วยลด 1 ปัจจัยลง 3% และจะใช้กับธุรกรรมการซื้อ ผลิตภัณฑ์การชำระเงิน และนักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลัง เนื่องจากคุณสมบัติสำหรับการระบุ ไม่ได้ระบุนักพัฒนาซอฟต์แวร์หรือแพ็กเกจ API การปรับปรุงจะมีผลกับนักพัฒนาซอฟต์แวร์ทั้งหมด (ที่ เป็นนักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลัง) และผลิตภัณฑ์การชำระเงินในแพ็กเกจ API ทั้งหมด

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

คำตอบควรมีลักษณะเช่นนี้ (แสดงเพียงบางส่วนของคำตอบ):

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

การดูการแก้ไขการเรียกเก็บเงินโดยใช้ API

คุณจะดูการแก้ไขการเรียกเก็บเงินที่ต้องการหรือการแก้ไขการเรียกเก็บเงินทั้งหมดขององค์กรได้ หากต้องการดูการแก้ไขการเรียกเก็บเงินที่ต้องการ โปรดส่งคำขอ GET ไปยัง /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} โดยที่ {billing_adjustment_id} คือหมายเลขการปรับค่าใช้จ่ายของการเรียกเก็บเงินที่เจาะจง (รหัสจะแสดงในการตอบกลับเมื่อคุณสร้างการแก้ไขการเรียกเก็บเงิน) เช่น

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

หากต้องการดูการแก้ไขการเรียกเก็บเงินทั้งหมดขององค์กร ให้ส่งคำขอ GET ไปยัง /organizations/{org_name}/billing-adjustments เช่น

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

คำตอบควรมีลักษณะเช่นนี้ (แสดงเพียงบางส่วนของคำตอบ):

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

กำลังอัปเดตการแก้ไขการเรียกเก็บเงินโดยใช้ API

คุณสามารถอัปเดตการแก้ไขการเรียกเก็บเงินได้โดยการส่งคำขอ PUT ไปยัง /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} โดยที่ {billing_adjustment_id} คือหมายเลขระบุการปรับค่าใช้จ่ายของการเรียกเก็บเงินที่เจาะจง เมื่อคุณทำการอัปเดต คุณต้องระบุคุณสมบัติที่อัปเดตและพร็อพเพอร์ตี้ที่อัปเดตในเนื้อหาคำขอ การระบุการแก้ไขการเรียกเก็บเงินที่จะอัปเดต คุณยังต้องระบุ พร็อพเพอร์ตี้สำหรับการแก้ไขการเรียกเก็บเงิน กล่าวคือ พร็อพเพอร์ตี้สำหรับชื่อ เปอร์เซ็นต์การปรับค่าใช้จ่าย เดือนที่เรียกเก็บเงิน ปีที่เรียกเก็บเงิน และองค์กร

ตัวอย่างเช่น การเรียก API ต่อไปนี้จะอัปเดตปัจจัยและชื่อการปรับเปอร์เซ็นต์ (พารามิเตอร์ พร็อพเพอร์ตี้ที่อัปเดตมีการไฮไลต์ในตัวอย่าง)

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

การลบการแก้ไขการเรียกเก็บเงินโดยใช้ API

คุณสามารถลบการแก้ไขการเรียกเก็บเงินได้โดยการส่งคำขอ DELETE ไปยัง /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} โดยที่ {billing_adjustment_id} คือหมายเลขระบุการปรับค่าใช้จ่ายของการเรียกเก็บเงิน ลบแล้ว เช่น

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

การกำหนดการแก้ไขการเรียกเก็บเงินสำหรับ API

ตัวเลือกการกำหนดค่าต่อไปนี้ใช้ได้กับการแก้ไขการเรียกเก็บเงิน

ชื่อ คำอธิบาย ค่าเริ่มต้น จำเป็นหรือไม่
name

ชื่อที่สื่อความหมายสำหรับการแก้ไขการเรียกเก็บเงิน

ไม่มี ใช่
adjustmentPercentageFactor

จำนวนเงินของการปรับปรุงเป็นเปอร์เซ็นต์ตัวเลขบวกหรือลบ ผลบวก เปอร์เซ็นต์จะปรับส่วนแบ่งรายได้หรือค่าธรรมเนียมในธุรกรรมตามเปอร์เซ็นต์นั้น ต เปอร์เซ็นต์ติดลบจะปรับส่วนแบ่งรายได้หรือค่าธรรมเนียมในธุรกรรมลงตามนั้น เปอร์เซ็นต์ ค่าอยู่ในช่วงระหว่าง -100 ถึง 999.9999

ไม่มี ใช่
billingMonth

เดือนที่เรียกเก็บเงินสำหรับการแก้ไขการเรียกเก็บเงิน ระบุเป็นจำนวนเต็ม เช่น 11 ของเดือนธันวาคม

ไม่มี ใช่
billingYear

ปีที่เรียกเก็บเงินสำหรับการแก้ไขการเรียกเก็บเงิน ซึ่งระบุโดยใช้รูปแบบต่อไปนี้ ปปปป เช่น 2017

ไม่มี ใช่
organization

องค์กรที่มีการปรับค่าใช้จ่ายการเรียกเก็บเงิน

ไม่มี ใช่
isPublished

แฟล็กที่ระบุว่าควรเผยแพร่การปรับปรุงหรือไม่ ค่าอาจเป็นได้ 1 รายการ ดังต่อไปนี้

  • true การแก้ไขการเรียกเก็บเงินควรได้รับการเผยแพร่แล้ว
  • false ไม่ควรเผยแพร่การแก้ไขการเรียกเก็บเงิน
ไม่มี ไม่ได้
transactionType

ประเภทธุรกรรมที่มีการปรับการเรียกเก็บเงิน ประเภทอาจเป็นได้ประเภทเดียว ดังต่อไปนี้

  • PURCHASE
  • CHARGE
  • REFUND
  • CREDIT
  • BALANCE
  • SETUPFEES
  • TERMINATIONFEES
  • RECURRINGFEES
  • TRUEUPS นี่คือธุรกรรมที่ใช้ปรับการจัดประเภทใหม่ ธุรกรรม จะมีการเรียกใช้เมื่อมีการเปลี่ยนแปลงภาษีในการเรียกเก็บเงินก่อนหน้านี้ เดือน
ไม่มี ไม่ได้
developerBillingType

ประเภทการเรียกเก็บเงินของนักพัฒนาแอปที่มีการปรับการเรียกเก็บเงิน ค่านี้สามารถเป็น ดำเนินการอย่างใดอย่างหนึ่งต่อไปนี้

  • PREPAID. นักพัฒนาแอปแบบชำระเงินล่วงหน้า
  • POSTPAID นักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลัง
  • BOTH นักพัฒนาแอปแบบชำระเงินล่วงหน้าและแบบชำระเงินภายหลัง
ไม่มี ไม่ได้
product

ผลิตภัณฑ์ API ที่มีการปรับค่าใช้จ่ายการเรียกเก็บเงิน หากคุณไม่ระบุ ในพร็อพเพอร์ตี้นี้ การแก้ไขการเรียกเก็บเงินจะมีผลกับผลิตภัณฑ์ API ทั้งหมด

ไม่มี ไม่ได้
monetizationPackage

แพ็กเกจ API ที่มีการปรับค่าใช้จ่ายการเรียกเก็บเงิน หากคุณไม่ระบุ ในพร็อพเพอร์ตี้นี้ การปรับการเรียกเก็บเงินจะมีผลกับแพ็กเกจ API ทั้งหมด

ไม่มี ไม่ได้
developer

นักพัฒนาซอฟต์แวร์ที่เป็นเจ้าของการแก้ไขการเรียกเก็บเงิน หากไม่ระบุ การปรับปรุงการเรียกเก็บเงินจะมีผลกับนักพัฒนาซอฟต์แวร์ทุกราย

ไม่มี ไม่ได้

ขั้นตอนถัดไป

การสร้างรายได้ให้ความยืดหยุ่นในการออกเครดิตแก่นักพัฒนาซอฟต์แวร์ คุณอาจต้องทำ กรณีนี้หากนักพัฒนาซอฟต์แวร์ไม่พอใจกับบริการและขอเงินคืนบางส่วนหรือคืนเงินเต็มจำนวนในการใช้งาน ในช่วงระยะเวลาหนึ่ง เรียนรู้วิธีออกเครดิตในการออกเครดิต