กําหนดค่าแพ็กเกจส่วนแบ่งรายได้

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

บทนำ

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

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

การระบุรายละเอียดแผนส่วนแบ่งรายได้โดยใช้ UI

กำหนดค่าแผนส่วนแบ่งรายได้ตามที่อธิบายไว้ด้านล่าง

Edge

หากต้องการกำหนดค่าแผนส่วนแบ่งรายได้โดยใช้ UI ของ Edge เมื่อสร้าง หรือแก้ไข แพ็กเกจราคา ให้เลือกประเภทแพ็กเกจราคาส่วนแบ่งรายได้ หรือตารางราคาและส่วนแบ่งรายได้ แล้วกำหนดค่าข้อมูลต่อไปนี้ในส่วนส่วนแบ่งรายได้

ฟิลด์ คำอธิบาย
รูปแบบการคำนวณ เลือกประเภทการกำหนดราคาใดประเภทหนึ่งต่อไปนี้
  • ราคาขาย - ส่วนแบ่งรายได้อิงตามเปอร์เซ็นต์ของราคาขายของธุรกรรม
  • ราคาสุทธิ - ส่วนแบ่งรายได้อิงตามเปอร์เซ็นต์ของราคาสุทธิของธุรกรรม
หมายเหตุ: คุณกำหนดราคาขายหรือราคาสุทธิสำหรับธุรกรรมเมื่อคุณสร้างนโยบายการบันทึกธุรกรรม
ความถี่ในการคำนวณ ช่วงเวลาที่ระบบคำนวณปริมาณธุรกรรม (หรือปริมาณที่เกี่ยวข้องกับแอตทริบิวต์ที่กำหนดเอง) เลือกจำนวนเดือน (1-24 เดือน)
รูปแบบการแบ่งรายได้ เลือกรุ่นส่วนแบ่งรายได้ใดรุ่นหนึ่งต่อไปนี้
  • คงที่ - ผู้ให้บริการ API จะแบ่งรายได้เป็นเปอร์เซ็นต์คงที่กับนักพัฒนาแอป ซึ่งรายได้ดังกล่าวมาจากธุรกรรมแต่ละรายการ (อิงตามราคาขายหรือราคาสุทธิของธุรกรรม)
  • ยืดหยุ่น - ผู้ให้บริการ API จะแบ่งรายได้เป็นเปอร์เซ็นต์ที่เปลี่ยนแปลงได้กับนักพัฒนาแอป ส่วนแบ่งรายได้จะขึ้นอยู่กับรายได้ที่เกิดขึ้นในช่วงเวลาหนึ่ง เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้อาจแตกต่างกันไปตามจำนวนรายได้ที่เกิดจากธุรกรรม
ส่วนแบ่งรายได้คงที่ สำหรับรูปแบบการแบ่งรายได้แบบคงที่ ให้ระบุเปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้ ป้อนเลขทศนิยม (มีทศนิยมได้สูงสุด 4 ตำแหน่ง) เช่น หากป้อน 80.5555 ส่วนแบ่งรายได้จะเป็น 80.5555% ซึ่งหมายความว่าในฐานะผู้ให้บริการ API คุณจะจ่ายเงินให้นักพัฒนาแอป 80.5555% ของราคาที่เรียกเก็บสำหรับธุรกรรมแต่ละรายการ
ช่วงส่วนแบ่งรายได้

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

ระบุขีดจำกัดบนของช่วงแรก เช่น สูงสุด 1,000 (ระบบจะกำหนดขีดจำกัดล่างไว้ล่วงหน้าให้มากกว่า 0) คลิก +ใหม่ เพื่อเพิ่มช่วง ปล่อยให้ขีดจำกัดบนของช่วงสุดท้ายว่างไว้เพื่อระบุธุรกรรมทั้งหมดหลังจากที่รายได้รวมสูงกว่าระดับนี้

เช่น หากคุณระบุช่วงรายได้ 2 ช่วงในส่วนช่วงรายได้ (>0-1000 และ 1000 ขึ้นไป) คุณอาจป้อน 80.5555 สำหรับช่วงรายได้ >0-1000 และ 90.5 สำหรับช่วงรายได้ 1000 ขึ้นไป และสมมติว่าสกุลเงินเป็นดอลลาร์สหรัฐ จากนั้นสำหรับธุรกรรมที่สร้างรายได้สูงสุด $1,000 ส่วนแบ่งรายได้จะเป็น 80.5555% ของราคาธุรกรรม และสำหรับธุรกรรมที่สร้างรายได้มากกว่า $1,000 ส่วนแบ่งรายได้จะเป็น 90.5% ของราคาธุรกรรม

Classic Edge (Private Cloud)

วิธีกำหนดค่าแผนส่วนแบ่งรายได้โดยใช้ UI ของ Classic Edge

  1. ทำตามขั้นตอนเพื่อสร้างแพ็กเกจราคา
  2. เลือกส่วนแบ่งรายได้ ในเมนูแบบเลื่อนลงประเภทแพ็กเกจราคาเพื่อกำหนดค่ารูปแบบรายได้
  3. หากแพ็กเกจ API ที่เลือกมีผลิตภัณฑ์ API หลายรายการ ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้

    หมายเหตุ: หากแพ็กเกจ API มีผลิตภัณฑ์ API รายการเดียว คุณสามารถข้ามขั้นตอนนี้ได้

    • แพ็กเกจเฉพาะผลิตภัณฑ์ เพื่อกำหนดค่ารายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API แต่ละรายการแยกกัน
    • แพ็กเกจทั่วไปสำหรับผลิตภัณฑ์ทั้งหมด เพื่อกำหนดค่ารายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API ทั้งหมด
  4. คลิกส่วนแบ่งรายได้ สำหรับแพ็กเกจราคาทั่วไปหรือสำหรับแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API แต่ละรายการ

    หมายเหตุ: เมื่อกำหนดค่าแพ็กเกจเฉพาะผลิตภัณฑ์ API คุณจะต้องกำหนดค่าแผนส่วนแบ่งรายได้ สำหรับผลิตภัณฑ์ API แต่ละรายการแยกกัน

    หน้าต่างส่วนแบ่งรายได้จะเปิดขึ้น

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

    สำหรับรูปแบบการแบ่งรายได้แบบคงที่

    หากเลือกรุ่นการแบ่งรายได้แบบคงที่ ให้ป้อนข้อมูลต่อไปนี้ในส่วนการกำหนดราคา ของหน้าต่างส่วนแบ่งรายได้ทั่วไป

    ฟิลด์ คำอธิบาย
    ผู้ให้บริการ (หรือองค์กร)

    ชื่อองค์กรของคุณ ระบบจะกำหนดค่าฟิลด์นี้ไว้ล่วงหน้าโดยใช้ค่าฟิลด์ผู้ให้บริการ (หรือ องค์กร) ในโปรไฟล์องค์กร

    ประเทศ

    ประเทศที่องค์กรของคุณดำเนินงาน ระบบจะกำหนดค่าฟิลด์นี้ไว้ล่วงหน้าโดยใช้ค่าฟิลด์ประเทศในโปรไฟล์องค์กร

    สกุลเงิน

    สกุลเงิน "หลัก" หรือสกุลเงินที่ใช้ในการบัญชีของบริษัท ระบบจะกำหนดค่าฟิลด์นี้ไว้ล่วงหน้า โดยใช้ค่าฟิลด์สกุลเงินในโปรไฟล์องค์กร

    ประเภทการกำหนดราคา

    ฐานของส่วนแบ่งรายได้ เลือกราคาขายหรือราคาสุทธิ หากเลือกราคาขาย ส่วนแบ่งรายได้จะอิงตามเปอร์เซ็นต์ของราคาขายของธุรกรรม หากเลือกราคาสุทธิ ส่วนแบ่งรายได้จะอิงตามเปอร์เซ็นต์ของราคาสุทธิของธุรกรรม หมายเหตุ: คุณกำหนดราคาขายหรือราคาสุทธิสำหรับธุรกรรมเมื่อคุณสร้างนโยบายการบันทึกธุรกรรม

    ส่วนแบ่งคงที่ %

    เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้ ป้อนเลขทศนิยม (มี ทศนิยมได้สูงสุด 4 ตำแหน่ง) เช่น หากป้อน 80.5555 ส่วนแบ่งรายได้จะเป็น 80.5555% ซึ่งหมายความว่าในฐานะผู้ให้บริการ API คุณจะจ่ายเงินให้นักพัฒนาแอป 80.5555% ของราคาที่ เรียกเก็บสำหรับธุรกรรมแต่ละรายการ

    สำหรับรูปแบบการแบ่งรายได้แบบยืดหยุ่น

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

    ป้อนข้อมูลต่อไปนี้ในหน้าต่างส่วนแบ่งรายได้ทั่วไป

    ฟิลด์ คำอธิบาย
    ฐานการรวม

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

    ช่วงรายได้

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

    ระบุขีดจำกัดบนของช่วงแรก เช่น สูงสุด 1,000 (ระบบจะกำหนดขีดจำกัดล่าง ไว้ล่วงหน้าให้มากกว่า 0) คลิก + เพื่อเพิ่มช่วงที่ 2 เช่น มากกว่า 1, 000 และสูงสุด 2,000 คลิก + เพื่อเพิ่มช่วงอื่นๆ คุณสามารถปล่อยให้ขีดจำกัดบนของช่วงสุดท้ายว่างไว้เพื่อระบุธุรกรรมทั้งหมดหลังจากที่รายได้รวมสูงกว่าระดับนี้

    การกำหนดราคา
    ผู้ให้บริการ (หรือองค์กร)

    ชื่อองค์กรของคุณ ระบบจะกำหนดค่าฟิลด์นี้ไว้ล่วงหน้าโดยใช้ค่าฟิลด์ผู้ให้บริการ (หรือ องค์กร) ในโปรไฟล์องค์กร

    ประเทศ

    ประเทศที่องค์กรของคุณดำเนินงาน ระบบจะกำหนดค่าฟิลด์นี้ไว้ล่วงหน้าโดยใช้ค่าฟิลด์ประเทศในโปรไฟล์องค์กร

    สกุลเงิน

    สกุลเงิน "หลัก" หรือสกุลเงินที่ใช้ในการบัญชีขององค์กร ระบบจะกำหนดค่าฟิลด์นี้ไว้ล่วงหน้าโดยใช้ค่าฟิลด์สกุลเงินในโปรไฟล์องค์กร

    ประเภทการกำหนดราคา

    ฐานของส่วนแบ่งรายได้ เลือกราคาขายหรือราคาสุทธิ หากเลือกราคาขาย ส่วนแบ่งรายได้จะอิงตามเปอร์เซ็นต์ของราคาขายของธุรกรรม หากเลือกราคาสุทธิ ส่วนแบ่งรายได้จะอิงตามเปอร์เซ็นต์ของราคาสุทธิของธุรกรรม หมายเหตุ: คุณกำหนดราคาขายหรือราคาสุทธิสำหรับธุรกรรมเมื่อคุณสร้างนโยบายการบันทึกธุรกรรม

    ส่วนแบ่ง % สำหรับช่วงรายได้

    เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้สำหรับธุรกรรมในแต่ละ ช่วงรายได้ คุณระบุเปอร์เซ็นต์สำหรับแต่ละช่วงได้ ป้อนเลขทศนิยม (มีทศนิยมได้สูงสุด 4 ตำแหน่ง) เช่น หากคุณระบุช่วงรายได้ 2 ช่วงในส่วนช่วงรายได้ (>0-1000 และ 1000 ขึ้นไป) คุณอาจป้อน 80.5555 สำหรับช่วงรายได้ >0-1000 และ 90.5 สำหรับช่วงรายได้ 1000 ขึ้นไป และสมมติว่า สกุลเงินเป็นดอลลาร์สหรัฐ จากนั้นสำหรับธุรกรรมที่สร้างรายได้สูงสุด $1,000 ส่วนแบ่งรายได้จะเป็น 80.5555% ของราคาธุรกรรม และสำหรับ ธุรกรรมที่สร้างรายได้มากกว่า $1,000 ส่วนแบ่งรายได้จะเป็น 90.5% ของ ราคาธุรกรรม

  6. คลิก ใช้และปิด เพื่อบันทึกรายละเอียดส่วนแบ่งรายได้และกลับไปที่หน้าต่างแพ็กเกจราคามาตรฐาน
  7. สำหรับแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API ให้กำหนดค่ารายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API เพิ่มเติมตามที่จำเป็น

การระบุรายละเอียดแผนส่วนแบ่งรายได้โดยใช้ API

คุณระบุรายละเอียดแผนส่วนแบ่งรายได้เมื่อสร้างแพ็กเกจราคา โดยระบุรายละเอียด ในพร็อพเพอร์ตี้ ratePlanDetails ภายในเนื้อหาคำขอในการเรียกใช้ /organizations/{org_name}/monetization-packages/{package_id}/rate-plans สิ่งที่คุณ ระบุในพร็อพเพอร์ตี้ ratePlanDetails จะขึ้นอยู่กับรูปแบบการแบ่งรายได้ที่คุณเลือก: ซึ่งอาจเป็นแบบคงที่หรือแบบยืดหยุ่น

การระบุรายละเอียดแผนส่วนแบ่งรายได้สำหรับรูปแบบการแบ่งรายได้แบบคงที่

หากต้องการใช้รูปแบบการแบ่งรายได้แบบคงที่ ให้ระบุสิ่งต่อไปนี้ในรายละเอียดแพ็กเกจราคา

  • พารามิเตอร์การให้คะแนนที่ระบุว่าแพ็กเกจราคาอิงตามธุรกรรม (VOLUME) โดย VOLUME เป็นค่าเริ่มต้น
  • ประเภทการวัด (UNIT) ที่ระบุว่าส่วนแบ่งรายได้คงที่ต่อหน่วย (นั่นคือ ไม่ได้อิงตามปริมาณธุรกรรมเหมือนกับกรณีของรูปแบบการแบ่งรายได้แบบยืดหยุ่น )
  • ประเภทรายได้ (GROSS หรือ NET) ซึ่งระบุว่าส่วนแบ่งรายได้อิงตามราคาขายหรือราคาสุทธิของธุรกรรม
  • ระยะเวลาครบกำหนดชำระเงิน (เช่น 30 วัน)
  • รหัสองค์กรของคุณ
  • สกุลเงิน "หลัก" หรือสกุลเงินที่ใช้ในการบัญชีของบริษัท
  • อัตราแพ็กเกจราคาที่ให้รายละเอียดเกี่ยวกับวิธีคำนวณส่วนแบ่งรายได้ เนื่องจาก รูปแบบการแบ่งรายได้อิงตามอัตราคงที่ คุณจึงระบุอัตราแพ็กเกจราคาเพียงอัตราเดียว

ดูรายการพร็อพเพอร์ตี้รายละเอียดแพ็กเกจราคาทั้งหมดได้ที่พร็อพเพอร์ตี้การกำหนดค่าสำหรับรายละเอียดแพ็กเกจราคา

ในอัตราแพ็กเกจราคา คุณจะระบุสิ่งต่อไปนี้

  • ประเภทอัตราแพ็กเกจราคา (REVSHARE)
  • เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้ เช่น หากระบุ 80.5555, ส่วนแบ่งรายได้จะเป็น 80.5555% ซึ่งหมายความว่าในฐานะผู้ให้บริการ API คุณจะจ่ายเงินให้นักพัฒนาแอป 80.5555% ของ ราคาที่เรียกเก็บสำหรับธุรกรรมแต่ละรายการ (หรือหากอิงตามแอตทริบิวต์ที่กำหนดเอง เช่น จำนวน ไบต์ที่ส่งในธุรกรรม คุณจะจ่ายเงินให้นักพัฒนาแอป 80.5555% ของราคาที่เรียกเก็บสำหรับการ ส่งไบต์ตามจำนวนที่ระบุ)
  • หน่วยเริ่มต้นของการใช้ราคา (0) ซึ่งหมายความว่าระบบจะใช้ราคาดังกล่าวกับธุรกรรมแต่ละรายการ โดยเริ่มจากธุรกรรมแรก

ดูรายการพร็อพเพอร์ตี้แพ็กเกจราคาทั้งหมดได้ที่พร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคา

ตัวอย่างเช่น โค้ดต่อไปนี้จะสร้างแผนส่วนแบ่งรายได้ที่มีรูปแบบการแบ่งรายได้แบบคงที่ เปอร์เซ็นต์ส่วนแบ่งรายได้คือ 80.5555% ส่วนแบ่งรายได้อิงตามราคาสุทธิของธุรกรรม สัญญาจะมีผลตั้งแต่วันที่ 15 กันยายน 2013 และครบกำหนดชำระเงินภายใน 30 วัน (รายละเอียดที่เกี่ยวข้องกับส่วนแบ่งรายได้จะไฮไลต์ไว้)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "setUpFee": 10,
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

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

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

การระบุรายละเอียดแผนส่วนแบ่งรายได้สำหรับรูปแบบการแบ่งรายได้แบบยืดหยุ่น

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

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

  • พารามิเตอร์การให้คะแนนที่ระบุว่าแพ็กเกจราคาอิงตามธุรกรรม (VOLUME) โดย VOLUME เป็นค่าเริ่มต้น
  • ประเภทการวัด (VOLUME) ที่ระบุว่าส่วนแบ่งรายได้ไม่ได้อิงตาม ปริมาณธุรกรรม (นั่นคือ ไม่คงที่เหมือนกับกรณีของรูปแบบการแบ่งรายได้แบบคงที่
  • ประเภทรายได้ (GROSS หรือ NET) ซึ่งระบุว่าส่วนแบ่งรายได้อิงตามราคาขายหรือราคาสุทธิของธุรกรรม
  • ระยะเวลาครบกำหนดชำระเงิน (เช่น 30 วัน)
  • รหัสองค์กรของคุณ
  • สกุลเงิน "หลัก" หรือสกุลเงินที่ใช้ในการบัญชีของบริษัท
  • ระยะเวลาและประเภทระยะเวลาที่ระบุร่วมกันถึงช่วงเวลาที่ระบบรวมรายได้ (เรียกอีกอย่างว่า "ฐานการรวม") ระบบจะรวมธุรกรรมตามฐานการรวม (เช่น 1 เดือน) เพื่อคำนวณรายได้รวมและช่วงรายได้ที่เกี่ยวข้อง เปอร์เซ็นต์ส่วนแบ่งรายได้ที่ใช้กับธุรกรรมแต่ละรายการจะขึ้นอยู่กับช่วงรายได้ของธุรกรรมนั้น
  • ตัวนับการรวมที่ใช้เพื่อกำหนดช่วงรายได้ที่เกี่ยวข้อง

ดูรายการพร็อพเพอร์ตี้รายละเอียดแพ็กเกจราคาทั้งหมดได้ที่พร็อพเพอร์ตี้การกำหนดค่าสำหรับรายละเอียดแพ็กเกจราคา

สำหรับอัตราแพ็กเกจราคาแต่ละอัตรา คุณจะระบุสิ่งต่อไปนี้

  • ประเภทอัตราแพ็กเกจราคาสำหรับช่วงรายได้ (REVSHARE)
  • เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้สำหรับช่วงรายได้ เช่น หาก ระบุ 80.5555 ส่วนแบ่งรายได้สำหรับช่วงรายได้จะเป็น 80.5555% ซึ่งหมายความว่าในฐานะผู้ให้บริการ API คุณจะจ่ายเงินให้นักพัฒนาแอป 80.5555% ของราคาที่เรียกเก็บสำหรับธุรกรรมแต่ละรายการในช่วงรายได้นั้น
  • หน่วยเริ่มต้นและหน่วยสิ้นสุดของช่วงรายได้ หน่วยเริ่มต้นจะระบุขีดจำกัดล่าง ของช่วงรายได้ และหน่วยสิ้นสุดจะระบุขีดจำกัดบนของช่วงรายได้ เช่น หากระบุหน่วยเริ่มต้นเป็น 0 และหน่วยสิ้นสุดเป็น 1, 000 ช่วงรายได้จะครอบคลุมรายได้จากธุรกรรมที่มากกว่า 0 และสูงสุด 1, 000 ในสกุลเงินที่ระบุ หากสกุลเงินเป็นดอลลาร์สหรัฐ ฐานการรวมคือ 1 เดือน และเปอร์เซ็นต์สำหรับช่วงรายได้คือ 80.5555% สำหรับธุรกรรมที่สร้างรายได้สูงสุด $1,000 ต่อเดือน ส่วนแบ่งรายได้จะเป็น 80.5555% ของราคาธุรกรรม

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

ดูรายการพร็อพเพอร์ตี้แพ็กเกจราคาทั้งหมดได้ที่พร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคา

ตัวอย่างเช่น โค้ดต่อไปนี้จะสร้างแผนส่วนแบ่งรายได้ที่มีรูปแบบการแบ่งรายได้แบบยืดหยุ่น โดยระบุช่วงรายได้ 2 ช่วง ช่วงแรกครอบคลุมรายได้จากธุรกรรมที่มากกว่า 0 และสูงสุด 1,000 ดอลลาร์สหรัฐ ช่วงที่ 2 ครอบคลุมรายได้จากธุรกรรมที่มากกว่า 1,000 ดอลลาร์สหรัฐ เปอร์เซ็นต์ส่วนแบ่งรายได้ คือ 80.5555% สำหรับช่วงรายได้แรก และ 90.5% สำหรับช่วงรายได้ที่ 2 ส่วนแบ่งรายได้อิงตามราคาสุทธิของธุรกรรม ฐานการรวมคือ 1 เดือน ระยะเวลาสัญญาจะมีผลตั้งแต่วันที่ 15 กันยายน 2013 และครบกำหนดชำระเงินภายใน 30 วัน (รายละเอียดที่เกี่ยวข้องกับส่วนแบ่งรายได้ จะไฮไลต์ไว้)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",   
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

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

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
             "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}