การจัดการแพ็กเกจราคา

คุณกําลังดูเอกสาร Apigee Edge
ดูเอกสารประกอบเกี่ยวกับ Apigee X

จัดการแพ็กเกจราคาโดยใช้ UI และ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

การสํารวจหน้าแพ็กเกจราคา

เข้าถึงหน้าแพ็กเกจราคาตามที่อธิบายด้านล่าง

Edge

หากต้องการดูราคาแพ็กเกจใน Edge UI ให้เข้าไปที่หน้าแพ็กเกจราคาดังนี้

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

หน้าแพ็กเกจราคาจะแสดงขึ้นมา

ตัวอย่างราคาจะแสดงในหน้าแผนราคา

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

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

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

หน้าแพ็กเกจ API จะแสดงแพ็กเกจราคาที่กําหนดไว้สําหรับแต่ละแพ็กเกจ

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

การสร้างแพ็กเกจราคา

วิธีสร้างแพ็กเกจราคา

  1. เข้าถึงหน้าแพ็กเกจราคา
  2. คลิก +แพ็กเกจราคา
  3. กําหนดค่าช่องต่อไปนี้ในแผงด้านบน:
    ฟิลด์ คำอธิบาย ค่าเริ่มต้น จำเป็น
    ชื่อแพ็กเกจราคา ชื่อแพ็กเกจราคา

    หมายเหตุ: ชื่อต้องไม่ซ้ํากันภายในกลุ่มผลิตภัณฑ์ API แพ็กเกจ 2 รายการในแพ็กเกจผลิตภัณฑ์เดียวกันจะมีชื่อซ้ํากันไม่ได้

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

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

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

      กําหนดค่าหมวดหมู่นักพัฒนาซอฟต์แวร์ตามที่จําเป็นตามที่อธิบายไว้ในจัดการหมวดหมู่นักพัฒนาซอฟต์แวร์

    		 ทุกคน ไม่
    วันที่เริ่มต้น วันที่แพ็กเกจราคามีผล ป้อนวันที่เริ่มต้นหรือเลือกวันที่โดยใช้ปฏิทิน วันนี้ ไม่
    End date วันที่แพ็กเกจราคาสิ้นสุดลง หากต้องการระบุวันที่สิ้นสุด ให้เปิดสวิตช์มีวันที่สิ้นสุด แล้วป้อนวันที่สิ้นสุดหรือเลือกวันที่โดยใช้ปฏิทิน

    หมายเหตุ: แพ็กเกจราคาจะมีผลจนถึงเมื่อสิ้นสุดวันในวันที่ระบุ เช่น หากคุณต้องการต่ออายุแพ็กเกจราคาในวันที่ 1 ธันวาคม 2018 คุณควรตั้งค่า endDate เป็น 2018-11-30 ในกรณีนี้ แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันที่ 30 พฤศจิกายน 2018 โดยคําขอทั้งหมดในวันที่ 1 ธันวาคม 2018 จะถูกบล็อก

    		ไม่มี ไม่
    แสดงต่อพอร์ทัลต่างๆ กําหนดว่าแพ็กเกจราคาจะเป็นแบบสาธารณะหรือส่วนตัว ดูแพ็กเกจราคาแบบสาธารณะและแบบส่วนตัว เปิดใช้อยู่ ไม่
  4. กําหนดค่าค่าธรรมเนียมสําหรับแพ็กเกจราคา ดูการกําหนดค่าค่าธรรมเนียมสําหรับแพ็กเกจราคา
    หมายเหตุ: ใช้กับแพ็กเกจการแจ้งเตือนแบบปรับไม่ได้
  5. หากเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ ให้ตั้งค่ากําหนดต่อไปนี้ในส่วนแพ็กเกจราคาทั่วไปหรืออัตราทั่วไป
    หมายเหตุ: ขั้นตอนนี้ใช้ไม่ได้กับแพ็กเกจการแจ้งเตือนที่ปรับได้
    ฟิลด์ คำอธิบาย ค่าเริ่มต้น
    กําหนดค่าแต่ละผลิตภัณฑ์ ค่าสถานะที่ระบุว่าจะกําหนดค่าแพ็กเกจราคาแต่ละรายการสําหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่ ปิดใช้
    กําหนดค่าข้อเสนอฟรีเมียมของผลิตภัณฑ์แต่ละรายการ การแจ้งที่ระบุว่ากําหนดค่าแพ็กเกจฟรีเมียมสําหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่ ปิดใช้
    เลือกไอเทม ถ้าคุณเปิดใช้งานการตั้งค่าสถานะหนึ่งรายการหรือทั้งสองรายการ คุณจะต้องเลือกผลิตภัณฑ์แต่ละรายการจากรายการแบบเลื่อนลง และกําหนดค่ารายละเอียดของแผนอัตรา

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

    		ไม่มีข้อมูล
  6. กําหนดค่ารายละเอียดของแพ็กเกจราคาตามประเภทของแพ็กเกจราคาที่เลือก ดังนี้
  7. คลิกหนึ่งในตัวเลือกต่อไปนี้
    ปุ่ม คำอธิบาย
    บันทึกเป็นฉบับร่าง บันทึกแพ็กเกจราคาเป็นฉบับร่าง

    นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่ คุณแก้ไขช่องใดก็ได้ในแผนราคาฉบับร่าง

    เผยแพร่แพ็กเกจใหม่ เผยแพร่แพ็กเกจ

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

  8. แนบนโยบายการตรวจสอบขีดจํากัดการสร้างรายได้กับพร็อกซี API ที่เชื่อมโยงกับผลิตภัณฑ์ API ที่รวมอยู่ในแพ็กเกจราคา นโยบายการตรวจสอบขีดจํากัดการสร้างรายได้จะบังคับใช้ขีดจํากัดการสร้างรายได้ในพร็อกซี API และตรวจสอบว่าบันทึกข้อผิดพลาดทั้งหมดได้อย่างถูกต้องในรายงาน Analytics และรายงานการสร้างรายได้ หากต้องการข้อมูลเพิ่มเติม โปรดดูการบังคับใช้ขีดจํากัดการสร้างรายได้บนพร็อกซี API

การแก้ไขแพ็กเกจราคา

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

วิธีแก้ไขแพ็กเกจราคามีดังนี้

  1. เข้าถึงหน้าแพ็กเกจราคา
  2. คลิกภายในแถวของแพ็กเกจราคาที่ต้องการแก้ไข
    แผงราคาห้องพักจะปรากฏขึ้น
  3. แก้ไขช่องของแพ็กเกจราคาได้ตามต้องการ
    หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้หากยังไม่ได้ตั้งค่าเท่านั้น
  4. คลิกหนึ่งในตัวเลือกต่อไปนี้
    ปุ่ม คำอธิบาย
    อัปเดตฉบับร่าง (แพ็กเกจฉบับร่าง) บันทึกแพ็กเกจราคาเป็นฉบับร่าง

    นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่ คุณแก้ไขช่องใดก็ได้ในแผนราคาฉบับร่าง
    เผยแพร่ฉบับร่าง (แพ็กเกจฉบับร่าง) เผยแพร่แพ็กเกจราคา

    หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้หากยังไม่ได้ตั้งค่าเท่านั้น คุณจะลบแพ็กเกจราคาหลังจากเผยแพร่แล้วไม่ได้ แต่จะหมดอายุและยกเลิกแพ็กเกจราคาในอนาคตได้ตามที่อธิบายไว้ในหมดอายุของแพ็กเกจราคาที่เผยแพร่
    วันที่สิ้นสุดที่อัปเดต (แพ็กเกจราคาที่เผยแพร่แล้ว) กําหนดวันที่สิ้นสุดของแผนที่เผยแพร่

    หมายเหตุ: คุณจะแก้ไขวันที่สิ้นสุดหลังจากกําหนดแพ็กเกจราคาที่เผยแพร่ไปแล้วไม่ได้แล้ว

การลบแผนอัตราค่าบริการฉบับร่าง

ลบแพ็กเกจราคาฉบับร่างหากไม่ต้องการใช้งานอีกต่อไป

หมายเหตุ: คุณจะลบแพ็กเกจราคาที่เผยแพร่แล้วไม่ได้

วิธีลบแพ็กเกจราคาฉบับร่าง

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

การจัดการแผนราคาโดยใช้ API

หัวข้อต่อไปนี้อธิบายวิธีจัดการแพ็กเกจราคาโดยใช้ API

การสร้างแผนราคาโดยใช้ API

หากต้องการสร้างแพ็กเกจราคา ให้ส่งคําขอ POST ไปยัง /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans โดยที่ {monetizationpackage_id} คือรหัสของแพ็กเกจผลิตภัณฑ์ API ที่คุณสร้างแพ็กเกจราคา (ระบบจะแสดงผลรหัสในการตอบกลับเมื่อคุณสร้างแพ็กเกจผลิตภัณฑ์ API)

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

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

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

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

ส่วนต่อไปนี้จะอธิบายถึงวิธีสร้างแพ็กเกจราคา

การสร้างแผนราคามาตรฐานโดยใช้ API

หากต้องการสร้างแพ็กเกจราคามาตรฐาน ให้ตั้งค่าแอตทริบิวต์ type เป็น STANDARD ดังที่แสดงในตัวอย่างต่อไปนี้

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

สร้างแพ็กเกจราคาสําหรับนักพัฒนาซอฟต์แวร์หรือบริษัทโดยใช้ API

หากต้องการใช้แพ็กเกจราคากับนักพัฒนาซอฟต์แวร์หรือบริษัทที่เฉพาะเจาะจง ให้ตั้งค่า type เป็น Developer นอกจากนี้ คุณยังต้องระบุนักพัฒนาซอฟต์แวร์หรือบริษัทในคําขอ โดยระบุรหัส ชื่อตามกฎหมาย และชื่อนักพัฒนาซอฟต์แวร์ของบริษัท

ตัวอย่างเช่น ข้อความที่ตัดตอนมาต่อไปนี้จะสร้างแพ็กเกจราคาสําหรับนักพัฒนาซอฟต์แวร์ Dev Five

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

การสร้างแผนอัตราหมวดหมู่นักพัฒนาซอฟต์แวร์โดยใช้ API

หากต้องการใช้แพ็กเกจราคากับหมวดหมู่นักพัฒนาซอฟต์แวร์ ให้ตั้งค่า type เป็น Developer_Category คุณต้องระบุหมวดหมู่นักพัฒนาซอฟต์แวร์ในคําขอด้วย เช่น

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

การสร้างแผนราคาเฉพาะผลิตภัณฑ์ API โดยใช้ API

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

ตัวอย่างต่อไปนี้จะสร้างแพ็กเกจส่วนแบ่งรายได้ที่มีผลิตภัณฑ์ API 2 รายการ

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

หากต้องการเพิ่มผลิตภัณฑ์ API ไปยังแพ็กเกจผลิตภัณฑ์ API ของ my-package คุณจะต้องเพิ่มรายละเอียดแพ็กเกจราคาสําหรับผลิตภัณฑ์ API ในส่วนเนื้อหาของคําขอ ดังที่อธิบายไว้ในการเพิ่มผลิตภัณฑ์ API ไปยังแพ็กเกจผลิตภัณฑ์ API ที่มีแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API 

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

การตั้งค่าแพ็กเกจราคาเป็นแบบสาธารณะหรือส่วนตัวโดยใช้ API

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

ตัวอย่างต่อไปนี้จะสร้างแผนอัตราส่วนลดเฉพาะบุคคล

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

การเผยแพร่แพ็กเกจราคาโดยใช้ API

หากต้องการเผยแพร่แพ็กเกจราคา ให้กําหนดค่าพร็อพเพอร์ตี้ published เป็น "จริง" เมื่อสร้างแพ็กเกจราคา นักพัฒนาซอฟต์แวร์จะดูแพ็กเกจราคาตั้งแต่วันที่ที่ระบุในพร็อพเพอร์ตี้ startDate ของแพ็กเกจได้

ตัวอย่างต่อไปนี้จะสร้างแพ็กเกจบัตรราคาและเผยแพร่ (ระบบแสดงคําขอเพียงบางส่วนเท่านั้น)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

การบันทึกฉบับร่างของแพ็กเกจราคาโดยใช้ API

หากต้องการบันทึกแพ็กเกจราคาโดยไม่เผยแพร่ ให้ตั้งค่า published เป็น False เมื่อสร้างแพ็กเกจราคา

ตัวอย่างต่อไปนี้จะสร้างแพ็กเกจบัตรราคาและบันทึกเป็นฉบับร่าง (แสดงเพียงบางส่วนของคําขอ)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

การแก้ไขแผนฉบับร่างฉบับร่างโดยใช้ API

หากต้องการอัปเดตฉบับร่างของแพ็กเกจราคา ให้ส่งคําขอ PUT ไปยัง /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} โดยที่ {package_id} เป็นตัวระบุแพ็กเกจ API และ {plan_Id} เป็นตัวระบุแพ็กเกจราคา เมื่อทําการอัปเดต คุณต้องระบุการตั้งค่าที่อัปเดตและเนื้อหาของแพ็กเกจราคาในส่วนเนื้อหาของคําขอ หากอัปเดตราคาแพ็กเกจราคา คุณต้องระบุรหัสของอัตราแพ็กเกจราคาด้วย ตัวอย่างเช่น คําขอต่อไปนี้จะอัปเดตอัตราของแพ็กเกจราคาในแพ็กเกจราคาที่มีรหัส location_flat_rate_card_plan (มีการไฮไลต์การอัปเดต)

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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/location_flat_rate_card_plan" \
-u email:password

คําตอบจะรวมอัตราแพ็กเกจราคาที่อัปเดตแล้ว (แสดงคําตอบเพียงบางส่วนเท่านั้น)

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

การดูแผนราคาโดยใช้ API

คุณดูแพ็กเกจราคาได้โดยใช้ API การสร้างรายได้ตามที่อธิบายไว้ในส่วนต่อไปนี้

การดูแพ็กเกจราคาทั้งหมดสําหรับองค์กรที่ใช้ API

หากต้องการดูแพ็กเกจราคาทั้งหมดขององค์กร โปรดส่งคําขอ GET ไปยัง /mint/organizations/{org_name}/rate-plans โดยที่ {org_name} เป็นชื่อองค์กรของคุณ

คุณสามารถส่งผ่านพารามิเตอร์ข้อความค้นหาต่อไปนี้ในการกรองผลลัพธ์:

พารามิเตอร์การค้นหา คำอธิบาย
all แฟล็กที่ระบุว่าจะแสดงผลแพ็กเกจราคาทั้งหมดหรือไม่ หากตั้งค่าเป็น false จํานวนแพ็กเกจราคาที่แสดงผลต่อหน้าจะกําหนดโดยพารามิเตอร์การค้นหา size ค่าเริ่มต้นคือ true
size จํานวนแพ็กเกจ API ที่แสดงผลต่อหน้าเว็บ หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้
page จํานวนหน้าที่คุณต้องการส่งคืน (หากใส่เลขหน้าในเนื้อหา) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

การดูแพ็กเกจราคาทั้งหมดสําหรับแพ็กเกจผลิตภัณฑ์ API ที่ใช้ API

หากต้องการดูแพ็กเกจราคาทั้งหมดสําหรับแพ็กเกจ API ให้ออกคําขอ GET ไปยัง /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans โดยที่ {package_id} คือรหัสของแพ็กเกจ API (ระบบจะส่งคืนรหัสแพ็กเกจเมื่อคุณสร้างแพ็กเกจการสร้างรายได้)

โดยค่าเริ่มต้นแล้ว ระบบจะแสดงเฉพาะแพ็กเกจราคาที่ใช้งานอยู่ สาธารณะ และแบบมาตรฐานเท่านั้น วิธีใส่

  • แพ็กเกจราคาฉบับร่างหรือที่หมดอายุ ตั้งค่าพารามิเตอร์การค้นหา current เป็น false (เช่น ?current=false)
  • แผนอัตราส่วนลดเฉพาะบุคคล ให้ตั้งค่าพารามิเตอร์การค้นหา showPrivate เป็น true (เช่น ?showPrivate=true)
  • แพ็กเกจราคามาตรฐานทั้งหมด ให้ตั้งค่าพารามิเตอร์การค้นหา standard เป็น true (เช่น ?standard=true)

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

การดูแพ็กเกจราคาสําหรับแพ็กเกจ API โดยใช้ API

หากต้องการดูแพ็กเกจราคาสําหรับแพ็กเกจ API ให้ออกคําขอ GET ไปยัง /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} โดยที่ {package_id} คือรหัสของแพ็กเกจ API และ {plan_id} คือรหัสของแพ็กเกจราคา (ระบบแสดงรหัสแพ็กเกจเมื่อคุณสร้างแพ็กเกจการสร้างรายได้ และส่งกลับรหัสแพ็กเกจราคาเมื่อคุณสร้างแพ็กเกจราคา)

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

ตัวอย่างของคําตอบมีดังต่อไปนี้

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

การดูแพ็กเกจราคาที่ใช้งานอยู่ทั้งหมดสําหรับนักพัฒนาซอฟต์แวร์ที่ใช้ API

หากต้องการดูแพ็กเกจราคาที่ใช้งานอยู่ทั้งหมดสําหรับนักพัฒนาซอฟต์แวร์ ให้ส่งคําขอ GET ไปที่ /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans โดยที่ {developer_id} คืออีเมลของนักพัฒนาซอฟต์แวร์

คุณสามารถส่งผ่านพารามิเตอร์ข้อความค้นหาต่อไปนี้ในการกรองผลลัพธ์:

พารามิเตอร์การค้นหา คำอธิบาย
all การแจ้งที่ระบุว่าจะแสดงผลแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false จํานวนแพ็กเกจ API ที่ส่งกลับต่อหน้าจะกําหนดโดยพารามิเตอร์การค้นหา size ค่าเริ่มต้นคือ false
size จํานวนแพ็กเกจ API ที่แสดงผลต่อหน้าเว็บ ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้
page จํานวนหน้าที่คุณต้องการส่งคืน (หากใส่เลขหน้าในเนื้อหา) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

ตัวอย่างของคําตอบมีดังต่อไปนี้

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

การดูแพ็กเกจราคาที่ยอมรับแล้วสําหรับนักพัฒนาซอฟต์แวร์ที่ใช้ API

หากต้องการดูแพ็กเกจราคาที่ใช้งานอยู่สําหรับนักพัฒนาซอฟต์แวร์ ให้ส่งคําขอ GET ไปยัง /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} โดยที่ {developer_id} เป็นอีเมลของนักพัฒนาแอป และ {developer_rateplan_id} เป็นรหัสของแพ็กเกจราคาที่ยอมรับซึ่งส่งกลับมาเมื่อคุณยอมรับแพ็กเกจราคาที่เผยแพร่

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

ตัวอย่างของคําตอบมีดังต่อไปนี้

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

การดูแพ็กเกจราคาที่ยอมรับสําหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API โดยใช้ API

หากต้องการดูแพ็กเกจราคาที่ยอมรับสําหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API คุณจะต้องส่งคําขอ GET ไปยัง /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product โดยที่ {developer_id} เป็นรหัสของนักพัฒนาซอฟต์แวร์ และ /{product_id} คือรหัสของผลิตภัณฑ์

โดยค่าเริ่มต้นแล้ว ระบบจะแสดงเฉพาะแพ็กเกจราคาสาธารณะในผลลัพธ์ หากต้องการแสดงแพ็กเกจราคาส่วนลดส่วนตัว ให้ตั้งค่าพารามิเตอร์การค้นหา showPrivate เป็น true (เช่น ?showPrivate=true)

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

การดูแพ็กเกจราคาทั้งหมดที่ยอมรับโดยนักพัฒนาซอฟต์แวร์ที่ใช้ API

หากต้องการดูแพ็กเกจราคาที่ได้รับการยอมรับโดยนักพัฒนาซอฟต์แวร์ ให้ส่งคําขอ GET ไปที่ /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans โดยที่ {developer_id} คือรหัสของนักพัฒนาซอฟต์แวร์

คุณสามารถส่งผ่านพารามิเตอร์ข้อความค้นหาต่อไปนี้ในการกรองผลลัพธ์:

พารามิเตอร์การค้นหา คำอธิบาย
all การแจ้งที่ระบุว่าจะแสดงผลแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false จํานวนแพ็กเกจ API ที่ส่งกลับต่อหน้าจะกําหนดโดยพารามิเตอร์การค้นหา size ค่าเริ่มต้นคือ false
size จํานวนแพ็กเกจ API ที่แสดงผลต่อหน้าเว็บ ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้
page จํานวนหน้าที่คุณต้องการส่งคืน (หากใส่เลขหน้าในเนื้อหา) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้

เช่น

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

ตัวอย่างของคําตอบมีดังต่อไปนี้

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

การลบแผนฉบับร่างฉบับร่างโดยใช้ API

หากต้องการลบฉบับร่างของแพ็กเกจราคา ให้ส่งคําขอลบให้ /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} โดยที่ {plan_Id} เป็นตัวระบุของแพ็กเกจราคาที่จะลบ และ {package_id} เป็นตัวระบุแพ็กเกจ API สําหรับแพ็กเกจราคา เช่น

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

พร็อพเพอร์ตี้การกําหนดค่าสําหรับแพ็กเกจราคา

เมื่อสร้างแพ็กเกจราคาโดยใช้ API คุณจะระบุการตั้งค่าการกําหนดค่าต่อไปนี้ได้

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

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

  • true - เรียกเก็บค่าธรรมเนียมที่เกิดขึ้นซ้ําๆ ล่วงหน้า ตัวอย่างเช่น หากระยะเวลาคือ 1 เดือน ระบบจะเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นประจําในใบแจ้งหนี้ที่สร้างขึ้นสําหรับเดือนที่สิ้นสุดการเรียกเก็บเงิน
  • false - ระบบจะเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นเมื่อสิ้นสุดรอบระยะเวลา เช่น หากระยะเวลาคือ 1 เดือน ระบบจะเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นประจําในใบแจ้งหนี้ในใบแจ้งหนี้เมื่อเดือนที่เรียกเก็บเงินปัจจุบันสิ้นสุดลง นี่คือค่าเริ่มต้น
 เท็จ ไม่
contractDuration

ระยะเวลาของสัญญาสําหรับแผนร่วมกับ contractDurationType เช่น หากต้องการระบุระยะเวลาของสัญญา 6 เดือน ให้ตั้งค่า contractDuration เป็น 6 และ contractDurationType เป็น MONTH

 ไม่มีข้อมูล ไม่
contractDurationType

ระยะเวลาของสัญญาสําหรับแผนร่วมกับ contractDuration ค่าที่ถูกต้องมีดังนี้

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 ไม่มีข้อมูล ไม่
currency

สกุลเงินที่ใช้สําหรับแพ็กเกจราคา ระบุรหัส ISO 4217 สําหรับสกุลเงิน เช่น usd สําหรับดอลลาร์สหรัฐหรือ chf สําหรับฟรังก์สวิส

 ไม่มีข้อมูล ได้
description

คําอธิบายแพ็กเกจราคา

 ไม่มีข้อมูล ได้
developer

รหัสนักพัฒนาซอฟต์แวร์ (ที่อยู่อีเมล) ระบุสําหรับแพ็กเกจราคาสําหรับนักพัฒนาซอฟต์แวร์เท่านั้น

 ไม่มีข้อมูล ไม่
developerCategory

รหัสหมวดหมู่นักพัฒนาซอฟต์แวร์ ระบุสําหรับแพ็กเกจราคาหมวดหมู่นักพัฒนาซอฟต์แวร์เท่านั้น

 ไม่มีข้อมูล ไม่
displayName

ชื่อที่แสดงที่เป็นมิตรกับผู้ใช้สําหรับแพ็กเกจราคา

 ไม่มีข้อมูล ได้
earlyTerminationFee

จะมีการเรียกเก็บค่าธรรมเนียมที่เรียกเก็บเพียงครั้งเดียวหากนักพัฒนาแอปสิ้นสุดแผนดังกล่าวก่อนถึงวันที่ต่ออายุ

 ไม่มีข้อมูล ไม่
endDate

วันที่แพ็กเกจสิ้นสุด นักพัฒนาซอฟต์แวร์จะดูแพ็กเกจราคาหลังจากวันที่นี้ไม่ได้ หากไม่ต้องการให้แผนราคาสิ้นสุดลงในวันที่ที่กําหนด ให้ระบุค่า Null สําหรับ endDate

แพ็กเกจราคาจะมีผลจนถึงเมื่อสิ้นสุดวันในวันที่ระบุ เช่น หากต้องการต่ออายุแพ็กเกจราคาในวันที่ 1 ธันวาคม 2016 คุณควรตั้งค่า endDate เป็น 2016-11-30 ในกรณีนี้ แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันที่ 30 พฤศจิกายน 2016 โดยคําขอทั้งหมด ในวันที่ 1 ธันวาคม 2016 จะถูกบล็อก

หมายเหตุ: เมื่อดูแพ็กเกจราคาโดยใช้ API จะมีการระบุเวลาประทับ endDate เป็น YYYY-MM-DD 00:00:00 ซึ่งอาจทําให้เข้าใจผิด

 ไม่มีข้อมูล ไม่
freemiumDuration

ระยะเวลาสําหรับช่วงฟรีเมียมรวมกับ freemiumDurationType เช่น หากต้องการระบุว่าระยะเวลาฟรีเมียมคือ 30 วัน ให้ตั้งค่า freemiumDuration เป็น 30 และ freemiumDurationType เป็น DAY

 ไม่มีข้อมูล ไม่
freemiumDurationType

ระยะเวลาสําหรับช่วงฟรีเมียมกับ freemiumDuration ค่าที่ถูกต้องได้แก่:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 ไม่มีข้อมูล ไม่
freemiumUnit

ปริมาณฟรีเมียม ค่าอาจเป็นจํานวนธุรกรรมหรือจํานวนหน่วยที่เกี่ยวข้องกับแอตทริบิวต์ที่กําหนดเองที่บันทึกไว้ในนโยบายการบันทึกธุรกรรม

 ไม่มีข้อมูล ไม่
frequencyDuration

ใช้ได้สําหรับค่าธรรมเนียมที่เกิดขึ้นซ้ําๆ เท่านั้น ระยะเวลาระหว่างการเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นประจําร่วมกับ frequencyDurationType เช่น หากต้องการระบุระยะเวลาระหว่างการเรียกเก็บค่าธรรมเนียมคือ 30 วัน ให้ตั้งค่า frequencyDuration เป็น 30 และ frequencyDurationType เป็น DAY

 ไม่มีข้อมูล ไม่
frequencyDurationType ใช้ได้สําหรับค่าธรรมเนียมที่เกิดขึ้นซ้ําๆ เท่านั้น ระยะเวลาระหว่างการเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นประจําร่วมกับ frequencyDuration ค่าที่ถูกต้องมีดังนี้
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 ไม่มีข้อมูล ไม่
isPrivate ติดธงที่ระบุว่าแพ็กเกจราคาเป็นแบบสาธารณะหรือส่วนตัว ค่าเริ่มต้นคือ false (สาธารณะ) ดูข้อมูลเพิ่มเติมได้ที่แพ็กเกจราคาแบบสาธารณะและแบบส่วนตัว ไม่มีข้อมูล ไม่
monetizationPackage

รหัสชุดผลิตภัณฑ์ API สําหรับแพ็กเกจราคา

 ไม่มีข้อมูล ไม่
name

ชื่อของแพ็กเกจราคา

 ไม่มีข้อมูล ได้
organization

รหัสองค์กรของแพ็กเกจราคา

 ไม่มีข้อมูล ได้
paymentDueDays

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

 ไม่มีข้อมูล ไม่
proRate

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

  • true - ค่าธรรมเนียมเริ่มต้นจะคิดตามสัดส่วนของจํานวนวันจนถึงสิ้นสุดระยะเวลา (หรือจํานวนวันที่ใช้ในช่วงเวลานั้น)
  • false - นักพัฒนาแอปจะเรียกเก็บค่าธรรมเนียมเริ่มต้นเต็มจํานวนไม่ว่านักพัฒนาแอปจะเริ่ม (หรือสิ้นสุด) แพ็กเกจเมื่อใด นี่คือค่าเริ่มต้น
 เท็จ ไม่
published

การแจ้งที่ระบุว่านักพัฒนาซอฟต์แวร์ควรเผยแพร่แพ็กเกจราคาเพื่อดูหรือไม่ ค่าที่ถูกต้องได้แก่:

  • true - เผยแพร่แพ็กเกจราคา
  • false - ไม่เผยแพร่แพ็กเกจราคา
 ไม่มีข้อมูล ได้
ratePlanDetails

รายละเอียดสําหรับแพ็กเกจราคา (ดูรายละเอียดการกําหนดค่าสําหรับรายละเอียดแพ็กเกจราคาของที่พัก)

 ไม่มีข้อมูล ได้
recurringFee

ค่าธรรมเนียมที่นักพัฒนาแอปเรียกเก็บอย่างต่อเนื่องจนกว่านักพัฒนาแอปจะสิ้นสุดแพ็กเกจ

 ไม่มีข้อมูล ไม่
recurringStartUnit

ใช้ได้เฉพาะเมื่อตั้งค่า recurringType เป็น CALENDAR เท่านั้น วันของเดือนเพื่อเรียกเก็บค่าธรรมเนียมที่เกิดซ้ํา เช่น หากมีการเรียกเก็บค่าธรรมเนียมที่เกิดซ้ําทุกเดือน และตั้งค่า recurringStartUnit เป็น 1 ระบบจะเรียกเก็บค่าธรรมเนียมที่เกิดซ้ําในวันแรกของแต่ละเดือน

 ไม่มีข้อมูล ไม่
recurringType

กําหนดเวลาสําหรับค่าธรรมเนียมที่เกิดซ้ํา ค่าที่ถูกต้องได้แก่:

  • CALENDAR - กําหนดเวลาไว้ตามปฏิทิน
  • CUSTOM - กําหนดเวลาตามการตั้งค่าวันที่ที่กําหนดเอง
 ไม่มีข้อมูล ไม่
setUpFee

ค่าธรรมเนียมที่เรียกเก็บเพียงครั้งเดียวซึ่งเรียกเก็บกับนักพัฒนาแอปแต่ละรายในวันที่เริ่มต้นของแผน (ซึ่งก็คือวันที่นักพัฒนาแอปซื้อแพ็กเกจ)

 ไม่มีข้อมูล ไม่
startDate

วันที่แพ็กเกจเริ่มต้น นักพัฒนาซอฟต์แวร์จะดูแพ็กเกจราคาได้ตั้งแต่วันที่นี้

 ไม่มีข้อมูล ได้
type

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

  • STANDARD มีผลกับนักพัฒนาซอฟต์แวร์ทั้งหมด
  • DEVELOPER_CATEGORY มีผลกับนักพัฒนาซอฟต์แวร์ทั้งหมดในหมวดหมู่ ที่เลือก
  • DEVELOPER มีผลกับนักพัฒนาซอฟต์แวร์หรือบริษัทที่เฉพาะเจาะจง
 ไม่มีข้อมูล ได้

พร็อพเพอร์ตี้การกําหนดค่าสําหรับรายละเอียดแพ็กเกจราคา

คุณจะระบุพร็อพเพอร์ตี้การกําหนดค่าต่อไปนี้เป็นส่วนหนึ่งของอาร์เรย์ ratePlanDetails เมื่อสร้างแพ็กเกจราคาได้

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

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

  • true - เปิดใช้ตัวนับรวม
  • false - ไม่ยื่นเรื่องโต้แย้งแบบรวม
 ไม่มีข้อมูล ไม่
aggregateStandardCounters

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

  • true - ใช้ตัวนับการรวม
  • false - อย่าใช้ตัวนับรวม
 ไม่มีข้อมูล ไม่
aggregateTransactions

หมายเหตุ: ปัจจุบันพร็อพเพอร์ตี้นี้ไม่ได้ใช้โดยการสร้างรายได้และจะไม่สนใจพร็อพเพอร์ตี้ดังกล่าว

 จริง ไม่
currency

สกุลเงิน

 ไม่มีข้อมูล ไม่
duration

ระยะเวลาสําหรับความถี่ของการคํานวณรวมกับ durationType โดยที่ค่า duration ที่อนุญาตคือ 1-24

เช่น ตั้งค่า duration เป็น 2 และ durationType เป็น MONTH เพื่อระบุความถี่ในการคํานวณ 2 เดือน

 ไม่มีข้อมูล ไม่
durationType

ระยะเวลาสําหรับความถี่ของการคํานวณรวมกับ duration ค่าที่ถูกต้องคือ MONTH เท่านั้น

โปรดดู duration สําหรับตัวอย่างการใช้งาน

 ไม่มีข้อมูล ไม่
freemiumDuration

ระยะเวลาสําหรับช่วงฟรีเมียมสําหรับผลิตภัณฑ์ API แต่ละรายการพร้อมกับ freemiumDurationType เช่น หากต้องการระบุว่าช่วงเวลาฟรีเมียมของผลิตภัณฑ์ API คือ 30 วัน ให้ตั้งค่า freemiumDuration เป็น 30 และ freemiumDurationType เป็น DAY

 ไม่มีข้อมูล ไม่
freemiumDurationType

ระยะเวลาสําหรับช่วงฟรีเมียมสําหรับผลิตภัณฑ์ API แต่ละรายการพร้อมกับ freemiumDuration ค่าที่ถูกต้องได้แก่:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

เช่น หากต้องการระบุว่าช่วงเวลาฟรีเมียมของผลิตภัณฑ์ API คือ 30 วัน ให้ตั้งค่า freemiumDuration เป็น 30 และ freemiumDurationType เป็น DAY

 ไม่มีข้อมูล ไม่
freemiumUnit

ปริมาณฟรีเมียมสําหรับผลิตภัณฑ์ API ค่าอาจเป็นจํานวนธุรกรรมหรือจํานวนหน่วยที่เกี่ยวข้องกับแอตทริบิวต์ที่กําหนดเองที่บันทึกไว้ในนโยบายการบันทึกธุรกรรม

 ไม่มีข้อมูล ไม่
meteringType

รูปแบบการชาร์จสําหรับแพ็กเกจบัตรราคา ค่าที่ถูกต้องได้แก่:

  • UNIT - รูปแบบการชาร์จแบบอัตราเดียว
  • VOLUME - รูปแบบการชาร์จแบบย่านความถี่
  • STAIR_STEP - รูปแบบการชาร์จแบบกลุ่ม
  • DEV_SPECIFIC - รูปแบบการชาร์จการแจ้งเตือนที่ปรับเปลี่ยนได้ ใช้ไม่ได้กับรูปแบบรายได้อื่นๆ
 ไม่มีข้อมูล ใช่
organization

รหัสองค์กร

 ไม่มีข้อมูล ไม่
paymentDueDays

วันที่ครบกําหนดชําระสําหรับนักพัฒนาซอฟต์แวร์แบบชําระเงินภายหลัง เช่น กําหนดค่าเป็น 30 เพื่อระบุว่าครบกําหนดชําระเงินภายใน 30 วัน

 ไม่มีข้อมูล ไม่
product

ข้อมูลผลิตภัณฑ์ API เช่น รหัส

 ไม่มีข้อมูล ไม่
ratePlanRates

รายละเอียดอัตราของแพ็กเกจ เช่น ประเภทของแพ็กเกจราคา (REVSHARE หรือ RATECARD), อัตราสําหรับแพ็กเกจราคา, ส่วนแบ่งรายได้สําหรับแพ็กเกจส่วนแบ่งรายได้ และช่วง (หน่วยเริ่มต้นและหน่วยสิ้นสุดที่ใช้อัตราแพ็กเกจราคา)

 ไม่มีข้อมูล ได้
ratingParameter

เกณฑ์ราคาแพ็กเกจ แพ็กเกจราคาจะอิงตามธุรกรรมหรือแอตทริบิวต์ที่กําหนดเอง ค่าที่ถูกต้องได้แก่:

  • VOLUME - แพ็กเกจราคาอิงตามปริมาณธุรกรรม
  • custom_attribute - ชื่อของแอตทริบิวต์ที่กําหนดเองที่ กําหนดไว้ในนโยบายการบันทึกธุรกรรมสําหรับผลิตภัณฑ์ API และใช้ได้สําหรับแพ็กเกจราคาเท่านั้น ไม่สามารถกําหนดชื่อแอตทริบิวต์ที่กําหนดเองเป็น VOLUME
 VOLUME ได้
ratingParameterUnit

หน่วยที่ใช้กับ ratingParameter. Only required if ratingParameter ถูกตั้งค่าเป็นแอตทริบิวต์ที่กําหนดเอง (ที่ไม่ได้ตั้งค่าเป็น VOLUME)

 ไม่มีข้อมูล ได้
revenueType

ส่วนแบ่งรายได้ในแผนส่วนแบ่งรายได้ ค่าที่ถูกต้องได้แก่:

  • GROSS - ส่วนแบ่งรายได้จะอิงตามเปอร์เซ็นต์ของราคารวมของ ธุรกรรม
  • NET - ส่วนแบ่งรายได้จะอิงตามเปอร์เซ็นต์ของราคาสุทธิของธุรกรรม
 ไม่มีข้อมูล ไม่
type

ประเภทแพ็กเกจราคา ค่าที่ถูกต้องได้แก่:

  • REVSHARE - รูปแบบส่วนแบ่งรายได้
  • RATECARD - รุ่นการ์ดราคา
  • REVSHARE_RATECARD - รูปแบบส่วนแบ่งรายได้และบัตรราคา
  • USAGE_TARGET - รูปแบบการแจ้งเตือนที่ปรับได้

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับประเภทแพ็กเกจราคาที่หัวข้อประเภทแพ็กเกจราคาที่รองรับ

 ไม่มีข้อมูล ได้