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

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

शुरुआती जानकारी

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

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

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

आय के बंटवारे की योजना कॉन्फ़िगर करें. इसके बारे में यहां बताया गया है.

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

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

फ़िक्स्ड शेयरिंग मॉडल के लिए, आय के बंटवारे के प्लान से जुड़ी जानकारी तय करना

शेयर करने के फ़िक्स मॉडल को लागू करने के लिए, आपको रेट प्लान की जानकारी में यह जानकारी देनी होगी:

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

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

रेट प्लान की दर में, आप यह जानकारी देते हैं:

• रेट प्लान के रेट का टाइप (REVSHARE).
• आय के हिस्से का हिसाब लगाने में इस्तेमाल किया गया प्रतिशत. उदाहरण के लिए, अगर 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% होगा.

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

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

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