आय के बंटवारे की योजना कॉन्फ़िगर करें

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

परिचय

रेवेन्यू के बंटवारे वाले प्लान में, एपीआई की सेवा देने वाली कंपनी, हर लेन-देन से होने वाले रेवेन्यू का कुछ प्रतिशत हिस्सा डेवलपर के साथ शेयर करती है. यह हिस्सा, लेन-देन की कुल या शुद्ध कीमत के आधार पर तय होता है. रेवेन्यू के बंटवारे का प्लान बनाते समय, आपको रेवेन्यू के बंटवारे का मॉडल बताना होगा. यह मॉडल तय या बदलाव किया जा सकने वाला हो सकता है. साथ ही, आपको कीमत तय करने का आधार भी बताना होगा. जैसे, रेवेन्यू का बंटवारा, लेन-देन की कुल या शुद्ध कीमत पर आधारित है या नहीं. लेन-देन रिकॉर्ड करने की नीति बनाते समय, लेन-देन के लिए कुल या कुल कीमत सेट की जाती है.

फ़िक्स्ड शेयरिंग मॉडल में, डेवलपर के साथ हर लेन-देन से जनरेट होने वाले रेवेन्यू का एक तय प्रतिशत शेयर किया जाता है (लेन-देन की कुल या नेट कीमत के आधार पर). ज़रूरत के मुताबिक रेवेन्यू के बंटवारे के मॉडल में, डेवलपर के साथ रेवेन्यू का अलग-अलग प्रतिशत शेयर किया जाता है. रेवेन्यू के बंटवारे का प्रतिशत, किसी समयावधि में जनरेट हुए रेवेन्यू पर निर्भर करता है. आय के बंटवारे का हिसाब लगाने के लिए इस्तेमाल किया गया प्रतिशत, लेन-देन से होने वाली आय के आधार पर अलग-अलग हो सकता है.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, रेवेन्यू के बंटवारे के प्लान की जानकारी देना

आय के बंटवारे के प्लान को कॉन्फ़िगर करने के लिए, यहां दिया गया तरीका अपनाएं.

एपीआई का इस्तेमाल करके, रेवेन्यू के बंटवारे के प्लान की जानकारी देना

रेट प्लान बनाते समय, आपको रेवेन्यू के बंटवारे की योजना की जानकारी देनी होती है. /organizations/{org_name}/monetization-packages/{package_id}/rate-plans को कॉल करने के लिए, अनुरोध के मुख्य हिस्से में ratePlanDetails प्रॉपर्टी की जानकारी दी जाती है. ratePlanDetails प्रॉपर्टी में जो जानकारी दी जाती है वह शेयर करने के चुने गए मॉडल पर निर्भर करती है: फ़िक्स्ड या फ़्लेक्सिबल.

रेवेन्यू के बंटवारे के तय मॉडल के लिए, रेवेन्यू के बंटवारे के प्लान की जानकारी देना

तय किए गए किराये के बंटवारे के मॉडल को लागू करने के लिए, किराये के प्लान की जानकारी में यह जानकारी दें:

• रेटिंग पैरामीटर, जो बताता है कि किराया प्लान लेन-देन (VOLUME) पर आधारित है. VOLUME डिफ़ॉल्ट है.
• यह एक ऐसी मीटरिंग टाइप (UNIT) है जिससे पता चलता है कि रेवेन्यू का बंटवारा हर यूनिट के हिसाब से तय होता है. इसका मतलब है कि यह ट्रांज़ैक्शन की संख्या पर आधारित नहीं होता, जैसा कि सुविधाजनक शेयरिंग मॉडल पर होता है.
• रेवेन्यू का टाइप (GROSS या NET). इससे पता चलता है कि रेवेन्यू का बंटवारा, लेन-देन की कुल कीमत या नेट कीमत के आधार पर किया जाता है या नहीं.
• पेमेंट करने की आखिरी तारीख (उदाहरण के लिए, 30 दिन).
• आपके संगठन का आईडी.
• आपकी कंपनी जिस "बेस" या लेखांकन मुद्रा का इस्तेमाल करती है.
• रेट प्लान की दर, जिससे आय के हिस्से का हिसाब लगाने के तरीके की जानकारी मिलती है. शेयर करने का मॉडल, तय दर पर आधारित होता है. इसलिए, आपको सिर्फ़ एक किराया प्लान की दर बतानी होती है.

किराया प्लान की जानकारी वाली प्रॉपर्टी की पूरी सूची के लिए, किराया प्लान की जानकारी के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

रेट प्लान के हिसाब से तय की गई कीमत में, यह जानकारी दी जाती है:

• किराये के प्लान की दर (REVSHARE) का टाइप.
• आय के बंटवारे का हिसाब लगाने के लिए इस्तेमाल किया जाने वाला प्रतिशत. उदाहरण के लिए, अगर आपने 80.5555 डाला है, तो रेवेन्यू का बंटवारा 80.5555% होगा. इसका मतलब है कि एपीआई की सेवा देने वाले के तौर पर, आपको हर ट्रांज़ैक्शन के लिए तय की गई कीमत का 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"
}

रेवेन्यू के बंटवारे के सुविधाजनक मॉडल के लिए, रेवेन्यू के बंटवारे के प्लान की जानकारी देना

ज़रूरत के हिसाब से शेयर करने के मॉडल में, किराये के प्लान की जानकारी दी जाती है. इसमें किराये के एक या उससे ज़्यादा प्लान की जानकारी शामिल होती है. हर किराया प्लान की दर, ट्रांज़ैक्शन से होने वाली आय की एक सीमा को कवर करती है. हर सीमा को "रेवेन्यू बैंड" कहा जाता है. आपके पास हर रेवेन्यू बैंड के लिए, रेवेन्यू के बंटवारे का प्रतिशत असाइन करने का विकल्प होता है.

किराये के प्लान की कीमतों के अलावा, किराये के प्लान की जानकारी में यह जानकारी भी दी जाती है:

• रेटिंग पैरामीटर, जो बताता है कि किराया प्लान लेन-देन (VOLUME) पर आधारित है. VOLUME डिफ़ॉल्ट है.
• मेज़रमेंट टाइप (VOLUME), जो बताता है कि आय का बंटवारा, लेन-देन की संख्या पर आधारित नहीं है. इसका मतलब है कि यह तय नहीं होता, जैसा कि तय किए गए बंटवारे के मॉडल के मामले में होता है.
• रेवेन्यू का टाइप (GROSS या NET). इससे पता चलता है कि रेवेन्यू का बंटवारा, लेन-देन की कुल कीमत या नेट कीमत के आधार पर किया जाता है या नहीं.
• पेमेंट करने की आखिरी तारीख (उदाहरण के लिए, 30 दिन).
• आपके संगठन का आईडी.
• आपकी कंपनी जिस "बेस" या लेखांकन मुद्रा का इस्तेमाल करती है.
• अवधि और अवधि का टाइप, जो एक साथ उस समयावधि के बारे में बताता है जिसके लिए आय को इकट्ठा किया जाता है. इसे "एग्रीगेशन के आधार" के तौर पर भी जाना जाता है. कुल आय और लागू होने वाले रेवेन्यू बैंड का हिसाब लगाने के लिए, लेन-देन को एक साथ जोड़ने के आधार (उदाहरण के लिए, एक महीने) पर इकट्ठा किया जाता है. हर लेन-देन पर लागू होने वाला रेवेन्यू के बंटवारे का प्रतिशत, उसके रेवेन्यू के बैंड पर निर्भर करता है.
• एग्रीगेशन काउंटर, जिनका इस्तेमाल लागू रेवेन्यू बैंड तय करने के लिए किया जाता है.

किराया प्लान की जानकारी वाली प्रॉपर्टी की पूरी सूची के लिए, किराया प्लान की जानकारी के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

रेट प्लान के हर रेट के लिए, आपको यह जानकारी देनी होगी:

• आय के बैंड (REVSHARE) के लिए, किराया प्लान की दर का टाइप.
• रेवेन्यू बैंड के रेवेन्यू में हिस्सेदारी का हिसाब लगाने के लिए इस्तेमाल किया गया प्रतिशत. उदाहरण के लिए, अगर आपने 80.5555 डाला है, तो आय के उस बैंड के लिए आय का बंटवारा 80.5555% होगा. इसका मतलब है कि एपीआई की सेवा देने वाले के तौर पर, आपको उस आय के बैंड में हर लेन-देन के लिए, डेवलपर को 80.5555% हिस्सा देना होगा.
• रेवेन्यू बैंड की शुरुआती और आखिरी यूनिट. शुरुआती यूनिट से रेवेन्यू बैंड की निचली सीमा का पता चलता है और आखिरी यूनिट से रेवेन्यू बैंड की ऊपरी सीमा का पता चलता है. उदाहरण के लिए, अगर आपने शुरुआती यूनिट 0 और आखिरी यूनिट 1,000 दी है, तो रेवेन्यू बैंड में बताई गई मुद्रा में, 0 से 1,000 तक के ट्रांज़ैक्शन रेवेन्यू को शामिल किया जाएगा. अगर मुद्रा डॉलर है, एग्रीगेशन का आधार एक महीना है, और रेवेन्यू बैंड का प्रतिशत 80.5555% है, तो एक महीने में 1,000 डॉलर तक का रेवेन्यू जनरेट करने वाले लेन-देन के लिए, रेवेन्यू का बंटवारा लेन-देन की कीमत का 80.5555% होगा.

  अगर आपने फ़ाइनल रेवेन्यू बैंड के लिए आखिरी यूनिट तय नहीं की है, तो उस बैंड के शेयर का प्रतिशत सभी लेन-देन पर लागू किया जाता है. ऐसा तब किया जाता है, जब कुल रेवेन्यू उस बैंड की शुरुआती यूनिट से ज़्यादा हो जाता है. उदाहरण के लिए, अगर आखिरी बैंड की शुरुआती इकाई 1000 (यू.एस. डॉलर मानकर) है और आप उस बैंड के लिए आखिरी इकाई तय नहीं करते हैं, तो कुल अवधि के दौरान बैंड का आय प्रतिशत, 1,000 डॉलर से ज़्यादा की आय के सभी लेन-देन पर लागू होगा.

किराया प्लान की प्रॉपर्टी की पूरी सूची देखने के लिए, किराया प्लान के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

उदाहरण के लिए, यहां रेवेन्यू के बंटवारे का ऐसा प्लान बनाया गया है जिसमें रेवेन्यू के बंटवारे का मॉडल, पार्टनर की ज़रूरत के हिसाब से तय किया जा सकता है. इसमें रेवेन्यू के दो बैंड तय किए जाते हैं. पहले बैंड में, 1,000 डॉलर से ज़्यादा के लेन-देन से मिलने वाला रेवेन्यू शामिल होता है. दूसरा बैंड 1000 यू.एस. डॉलर से अधिक के लेन-देन आय को कवर करता है. रेवेन्यू के पहले बैंड के लिए, रेवेन्यू के बंटवारे का प्रतिशत 80.5555% है. वहीं, रेवेन्यू के दूसरे बैंड के लिए, रेवेन्यू के बंटवारे का प्रतिशत 90.5% है. रेवेन्यू का हिस्सा, लेन-देन की कुल कीमत के हिसाब से तय होता है. डेटा इकट्ठा करने की अवधि एक महीना होती है. अनुबंध की अवधि 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"
}