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

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

บทนำ

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

สำรวจหน้าการปรับค่าใช้จ่ายในการเรียกเก็บเงิน

เข้าถึงหน้าการปรับค่าใช้จ่ายในการเรียกเก็บเงินตามที่อธิบายไว้ด้านล่าง

Edge

วิธีเข้าถึงหน้าการปรับค่าใช้จ่ายในการเรียกเก็บเงินโดยใช้ UI ของ Edge

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

หน้าการปรับค่าใช้จ่ายในการเรียกเก็บเงินจะปรากฏขึ้น

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

Classic Edge (Private Cloud)

วิธีเข้าถึงหน้าการปรับค่าใช้จ่ายในการเรียกเก็บเงินโดยใช้ UI ของ Classic Edge

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนด Management Server
  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 การปรับค่าใช้จ่ายนี้จะลดลง 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

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

ไม่มี ใช่
organization

องค์กรที่จะใช้การแก้ไขการเรียกเก็บเงิน

ไม่มี ใช่
isPublished

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

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

ประเภทธุรกรรมที่จะใช้การแก้ไขการเรียกเก็บเงิน ประเภทธุรกรรมจะเป็นค่าใดค่าหนึ่งต่อไปนี้

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

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

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

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

ไม่มี ไม่
monetizationPackage

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

ไม่มี ไม่
developer

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

ไม่มี ไม่

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

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