रेट प्लान मैनेज करना

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

यहां दिए गए सेक्शन में बताए गए तरीके के मुताबिक, यूज़र इंटरफ़ेस (यूआई) और API का इस्तेमाल करके, रेट प्लान मैनेज करें.

रेट प्लान के पेज को एक्सप्लोर करना

नीचे बताए गए तरीके से, रेट प्लान के पेज को ऐक्सेस करें.

Edge

Edge यूज़र इंटरफ़ेस (यूआई) में किराया प्लान देखने के लिए, रेट प्लान पेज पर जाएं:

  1. apigee.com/edge में साइन इन करें.
  2. बाएं नेविगेशन बार में, पब्लिश करें > कमाई करना > प्लान को रेटिंग दें चुनें.

आपको किराये के प्लान का पेज दिखेगा.

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

क्लासिक एज (प्राइवेट क्लाउड)

क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके दर प्लान देखने के लिए, एपीआई पैकेज पेज को ऐक्सेस करें:

  1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
  2. सबसे ऊपर मौजूद नेविगेशन बार में, पब्लिश करें > पैकेज चुनें.

एपीआई पैकेज पेज पर, हर पैकेज के लिए तय किए गए रेट प्लान दिखते हैं.

किराये के प्लान वाले पेज पर जाकर, ये काम किए जा सकते हैं:

रेट प्लान बनाना

रेट प्लान बनाने के लिए:

  1. किराये के प्लान वाले पेज को ऐक्सेस करें.
  2. +रेट प्लान पर क्लिक करें.
  3. टॉप पैनल में ये फ़ील्ड कॉन्फ़िगर करें:
    फ़ील्ड ब्यौरा डिफ़ॉल्ट ज़रूरी है
    रेट प्लान का नाम आपके रेट प्लान का नाम.

    ध्यान दें: एपीआई प्रॉडक्ट बंडल में, यह नाम यूनीक होना चाहिए. एक ही प्रॉडक्ट बंडल में दो प्लान का एक ही नाम नहीं हो सकता.

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

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

    		लागू नहीं हां
    दर्शक वह ऑडियंस जो रेट प्लान को ऐक्सेस कर सकती है. ड्रॉप-डाउन सूची से, इनमें से कोई एक वैल्यू चुनें:
    • सभी - सभी डेवलपर.
    • डेवलपर - डेवलपर या कंपनी. डेवलपर का नाम या कंपनी का नाम डालें. आपके टाइप करते ही, स्ट्रिंग वाली डेवलपर/कंपनी की सूची ड्रॉप-डाउन में दिखती है. ड्रॉप-डाउन सूची से डेवलपर या कंपनी के नाम पर क्लिक करें.
    • डेवलपर कैटगरी - डेवलपर कैटगरी. ड्रॉप-डाउन सूची से डेवलपर कैटगरी चुनें.

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

    		 सभी नहीं
    शुरू होने की तारीख वह तारीख जब रेट प्लान लागू होगा. शुरू होने की तारीख डालें या कैलेंडर का इस्तेमाल करके कोई तारीख चुनें. आज नहीं
    खत्म होने की तारीख रेट प्लान खत्म होने की तारीख. खत्म होने की तारीख तय करने के लिए, खत्म होने की तारीख है चालू करें,स्विच टॉगल करें और खत्म होने की तारीख डालें या कैलेंडर का इस्तेमाल करके कोई तारीख चुनें.

    ध्यान दें: किराया तय करने का प्लान, तय की गई तारीख को दिन के खत्म होने तक लागू रहेगा. उदाहरण के लिए, अगर आपको 1 दिसंबर, 2018 के लिए रेट प्लान की समयसीमा खत्म करनी है, तो आपको endDate वैल्यू को 30-11-2018 पर सेट करना होगा. इस मामले में, दर प्लान 30 नवंबर, 2018 को दिन के आखिर में खत्म हो जाएगा; 1 दिसंबर, 2018 को किए गए सभी अनुरोध ब्लॉक कर दिए जाएंगे.

    		कभी नहीं नहीं
    पोर्टल के लिए दृश्यमान सेट करें कि किराया प्लान सार्वजनिक है या निजी. सार्वजनिक बनाम निजी दर प्लान देखें. चालू नहीं
  4. रेट प्लान के लिए शुल्क कॉन्फ़िगर करें. रेट प्लान के लिए शुल्क कॉन्फ़िगर करना देखें.
    ध्यान दें: बदलाव किए जा सकने वाले नोटिफ़िकेशन प्लान पर यह लागू नहीं होता.
  5. अगर आपने ऐसा प्रॉडक्ट बंडल चुना है जिसमें एक से ज़्यादा एपीआई प्रॉडक्ट शामिल हैं, तो खास या सामान्य दर प्लान सेक्शन में, इन प्राथमिकताएं सेट करें:
    ध्यान दें: यह चरण, बदलाव किए जा सकने वाले नोटिफ़िकेशन प्लान पर लागू नहीं होता.
    फ़ील्ड ब्यौरा डिफ़ॉल्ट
    हर प्रॉडक्ट को अलग-अलग कॉन्फ़िगर करें यह फ़्लैग बताता है कि हर एपीआई प्रॉडक्ट के लिए, दर का अलग प्लान कॉन्फ़िगर करना है या नहीं. अक्षम किया गया
    हर प्रॉडक्ट के फ़्रीमियम ऑफ़र को अलग-अलग कॉन्फ़िगर करें यह फ़्लैग बताता है कि हर एपीआई प्रॉडक्ट के लिए फ़्रीमियम प्लान कॉन्फ़िगर करना है या नहीं. अक्षम किया गया
    प्रॉडक्ट चुनें अगर एक या दोनों फ़्लैग चालू किए जाते हैं, तो आपको ड्रॉप-डाउन सूची से हर प्रॉडक्ट को अलग-अलग चुनना होगा और रेट प्लान की जानकारी कॉन्फ़िगर करनी होगी.

    ध्यान दें: पक्का करें कि आपने प्रॉडक्ट बंडल में सभी प्रॉडक्ट कॉन्फ़िगर किए हों.

    		लागू नहीं
  6. चुने गए रेट प्लान की जानकारी के आधार पर, रेट प्लान की जानकारी कॉन्फ़िगर करें:
  7. इनमें से किसी एक पर क्लिक करें:
    बटन ब्यौरा
    ड्राफ़्ट के रूप में सेव करें रेट प्लान को ड्राफ़्ट के तौर पर सेव करें.

    रेट प्लान, ऐप्लिकेशन डेवलपर को तब तक नहीं दिखेगा, जब तक इसे पब्लिश नहीं किया जाता. दर प्लान के ड्राफ़्ट के किसी भी फ़ील्ड में बदलाव किया जा सकता है.

    नया प्लान पब्लिश करना प्लान पब्लिश करें.

    ध्यान दें: रेट प्लान को पब्लिश करने के बाद, खत्म होने की तारीख में सिर्फ़ तब बदलाव किया जा सकता है, जब उसे पहले से सेट न किया गया हो. रेट प्लान को पब्लिश होने के बाद मिटाया नहीं जा सकता. हालांकि, पब्लिश किए गए रेट प्लान की समयसीमा खत्म करना लेख में बताए गए तरीके से, उसकी समयसीमा को खत्म किया जा सकता है. साथ ही, उसे आने वाले समय में लॉन्च होने वाले रेट प्लान से बदला जा सकता है.

  8. रेट प्लान में शामिल एपीआई प्रॉडक्ट से जुड़े एपीआई प्रॉक्सी में, कमाई करने की सीमाओं की जांच से जुड़ी नीति अटैच करें. कमाई करने की सीमाओं की जांच करने से जुड़ी नीति, एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करती है. साथ ही, यह पक्का करती है कि आंकड़ों और कमाई करने से जुड़ी रिपोर्ट में किसी भी तरह की गड़बड़ी को सही तरीके से शामिल किया गया हो. ज़्यादा जानकारी के लिए, एपीआई प्रॉक्सी पर कमाई करने की सीमाएं लागू करना देखें.

रेट प्लान में बदलाव करना

आपके पास प्रॉडक्ट बंडल, टाइप, और ऑडियंस को छोड़कर, ड्राफ़्ट रेट प्लान के सभी फ़ील्ड में बदलाव करने का विकल्प होता है. रेट प्लान को पब्लिश करने के बाद, खत्म होने की तारीख में सिर्फ़ तब बदलाव किया जा सकता है, जब खत्म होने की कोई तारीख न दी गई हो.

रेट प्लान में बदलाव करने के लिए:

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

    दर प्लान तब तक ऐप्लिकेशन डेवलपर को नहीं दिखेगा, जब तक उसे पब्लिश नहीं किया जाता. दर प्लान के ड्राफ़्ट के किसी भी फ़ील्ड में बदलाव किया जा सकता है.
    ड्राफ़्ट पब्लिश करें (ड्राफ़्ट रेट प्लान) रेट प्लान को पब्लिश करें.

    ध्यान दें: रेट प्लान को पब्लिश करने के बाद, उसके खत्म होने की तारीख में सिर्फ़ तब बदलाव किया जा सकता है, जब उसे पहले से सेट न किया गया हो. रेट प्लान को पब्लिश होने के बाद मिटाया नहीं जा सकता. हालांकि, पब्लिश किए गए रेट प्लान की समयसीमा खत्म करना लेख में बताए गए तरीके से, उसकी समयसीमा को खत्म किया जा सकता है. साथ ही, उसे आने वाले समय में लॉन्च होने वाले रेट प्लान से बदला जा सकता है.
    खत्म होने की अपडेट की गई तारीख (पब्लिश किए गए रेट प्लान) पब्लिश किए गए प्लान के खत्म होने की तारीख सेट करें.

    ध्यान दें: पब्लिश किए गए रेट प्लान के खत्म होने की तारीख सेट होने के बाद, उसमें बदलाव नहीं किया जा सकता.

ड्राफ़्ट रेट प्लान मिटाना

अगर दर प्लान की ज़रूरत नहीं है, तो उसे मिटाएं.

ध्यान दें: पब्लिश किया गया रेट प्लान मिटाया नहीं जा सकता.

ड्राफ़्ट रेट प्लान को मिटाने के लिए:

  1. किराये के प्लान वाले पेज को ऐक्सेस करें.
  2. ऐक्शन मेन्यू दिखाने के लिए, किराये के उस प्लान पर अपना कर्सर रखें जिसे मिटाना है.
  3. पर क्लिक करें.
  4. कार्रवाई की पुष्टि करने के लिए, मिटाएं पर क्लिक करें.

एपीआई का इस्तेमाल करके रेट प्लान मैनेज करना

नीचे दिए सेक्शन में, एपीआई का इस्तेमाल करके रेट प्लान मैनेज करने का तरीका बताया गया है.

एपीआई का इस्तेमाल करके रेट प्लान बनाना

रेट प्लान बनाने के लिए, /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans पर एक POST अनुरोध जारी करें. इसमें {monetizationpackage_id} उस एपीआई प्रॉडक्ट बंडल का आईडी है जिसके लिए रेट प्लान बनाया जाता है. एपीआई प्रॉडक्ट बंडल बनाने पर, रिस्पॉन्स के तौर पर आईडी दिखाया जाता है.

रेट प्लान बनाते समय, आपको अनुरोध के मुख्य हिस्से में यह जानकारी देनी होगी:

  • संगठन आईडी
  • एपीआई प्रॉडक्ट बंडल आईडी
  • रेट प्लान का नाम
  • रेट प्लान की जानकारी
  • रेट प्लान का स्कोप (चाहे यह सभी डेवलपर पर लागू हो या सिर्फ़ किसी खास डेवलपर, कंपनी या डेवलपर कैटगरी पर लागू हो)
  • वह तारीख जब रेट प्लान लागू होगा
  • रेट प्लान की मुद्रा
  • रेट प्लान को पब्लिश करना है या नहीं
  • रेट प्लान सार्वजनिक है या निजी है

ऐसी अन्य सेटिंग भी हैं जिनके बारे में विकल्प के तौर पर तय किया जा सकता है, जैसे कि पेमेंट की आखिरी तारीख (जैसे, 30 दिन). रेट प्लान के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

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

नीचे दिए सेक्शन में रेट प्लान बनाने का तरीका बताया गया है:

एपीआई का इस्तेमाल करके स्टैंडर्ड रेट प्लान बनाना

स्टैंडर्ड रेट प्लान बनाने के लिए, 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

एपीआई का इस्तेमाल करके डेवलपर या कंपनी के लिए रेट प्लान बनाना

किसी खास डेवलपर या कंपनी पर रेट प्लान लागू करने के लिए, type वैल्यू को Developer पर सेट करें. आपको अनुरोध में डेवलपर या कंपनी की पहचान भी करनी होगी. साथ ही, आईडी, कानूनी नाम, और कंपनी के डेवलपर का नाम भी देना होगा.

उदाहरण के लिए, नीचे दिया गया हिस्सा, Dev Five डेवलपर के लिए रेट प्लान बनाता है:

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

एपीआई का इस्तेमाल करके, डेवलपर कैटगरी के लिए रेट का प्लान बनाना

किसी डेवलपर कैटगरी पर रेट प्लान लागू करने के लिए, type की वैल्यू को Developer_Category पर सेट करें. आपको अनुरोध में दी गई डेवलपर कैटगरी की पहचान भी करनी होगी. उदाहरण के लिए:

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

एपीआई का इस्तेमाल करके, एपीआई के लिए प्रॉडक्ट के हिसाब से रेट प्लान बनाना

एक से ज़्यादा एपीआई प्रॉडक्ट वाले एपीआई प्रॉडक्ट बंडल के लिए रेट प्लान बनाते समय, एपीआई प्रॉडक्ट के लिए अलग-अलग रेट प्लान की जानकारी दी जा सकती है.

उदाहरण के लिए, यह दो एपीआई प्रॉडक्ट की मदद से, रेवेन्यू के बंटवारे का प्लान बनाता है:

$ 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

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

$ 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

एपीआई का इस्तेमाल करके, रेट प्लान को सार्वजनिक या निजी के तौर पर सेट करना

रेट का प्लान बनाते समय, अनुरोध के मुख्य भाग में 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

एपीआई का इस्तेमाल करके रेट प्लान पब्लिश करना

रेट प्लान पब्लिश करने के लिए, रेट प्लान बनाते समय 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

एपीआई का इस्तेमाल करके, रेट प्लान के ड्राफ़्ट को सेव करना

अगर आपको रेट प्लान को पब्लिश किए बिना सेव करना है, तो रेट प्लान बनाते समय published प्रॉपर्टी की वैल्यू को 'गलत' पर सेट करें.

उदाहरण के लिए, यहां एक रेट कार्ड प्लान बनाया जाता है और उसे ड्राफ़्ट के तौर पर सेव किया जाता है. हालांकि, अनुरोध का सिर्फ़ एक हिस्सा दिखाया जाता है:

$ 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

एपीआई का इस्तेमाल करके, रेट प्लान के ड्राफ़्ट में बदलाव करना

रेट प्लान के ड्राफ़्ट को अपडेट करने के लिए, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} पर एक PUT अनुरोध जारी करें. इसमें {package_id} एपीआई पैकेज की पहचान है और {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"
} ],
…

एपीआई का इस्तेमाल करके रेट प्लान देखना

इस सेक्शन में बताए गए तरीके से, कमाई करने के एपीआई का इस्तेमाल करके रेट प्लान देखे जा सकते हैं.

एपीआई का इस्तेमाल करके किसी संगठन के लिए सभी रेट प्लान देखना

किसी संगठन के सभी रेट प्लान देखने के लिए, /mint/organizations/{org_name}/rate-plans पर जीईटी अनुरोध भेजें. इसमें {org_name} आपके संगठन का नाम है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

क्वेरी पैरामीटर ब्यौरा
all यह फ़्लैग बताता है कि सभी रेट प्लान को लौटाना है या नहीं. अगर false पर सेट किया जाता है, तो हर पेज के लिए दिखाए गए रेट प्लान की संख्या size क्वेरी पैरामीटर से तय होती है. डिफ़ॉल्ट तौर पर, यह वैल्यू true होती है.
size हर पेज पर लौटाए गए एपीआई पैकेज की संख्या. अगर 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

एपीआई का इस्तेमाल करके, किसी एपीआई प्रॉडक्ट बंडल के लिए सभी रेट प्लान देखना

किसी एपीआई पैकेज के सभी रेट प्लान देखने के लिए, /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans पर GET अनुरोध जारी करें. इसमें {package_id}, एपीआई पैकेज का आईडी होता है. कमाई करने का पैकेज बनाने पर, पैकेज आईडी दिखता है.

डिफ़ॉल्ट रूप से, नतीजों में सिर्फ़ चालू, सार्वजनिक, और स्टैंडर्ड रेट प्लान दिखाए जाते हैं. शामिल करने के लिए:

  • रेट प्लान ड्राफ़्ट करें या उनकी समयसीमा खत्म हो गई है. ऐसे में, 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

एपीआई का इस्तेमाल करके, एपीआई पैकेज के लिए रेट प्लान देखना

किसी एपीआई पैकेज का रेट प्लान देखने के लिए, /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} के लिए जीईटी अनुरोध जारी करें. इसमें {package_id}, एपीआई पैकेज का आईडी है और {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"
 }

एपीआई का इस्तेमाल करके, डेवलपर के लिए सभी चालू दर प्लान देखना

डेवलपर के लिए सभी चालू दर प्लान देखने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans पर जीईटी अनुरोध जारी करें. इसमें {developer_id}, डेवलपर का ईमेल पता है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

क्वेरी पैरामीटर ब्यौरा
all यह फ़्लैग बताता है कि सभी एपीआई पैकेज लौटाने हैं या नहीं. अगर इस नीति को false पर सेट किया जाता है, तो हर पेज के लिए लौटाए गए एपीआई पैकेज की संख्या size क्वेरी पैरामीटर से तय होती है. डिफ़ॉल्ट तौर पर, यह वैल्यू false होती है.
size हर पेज पर लौटाए गए एपीआई पैकेज की संख्या. डिफ़ॉल्ट वैल्यू 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
}

एपीआई का इस्तेमाल करके, डेवलपर के लिए स्वीकार किया गया रेट प्लान देखना

किसी डेवलपर का चालू किराया प्लान देखने के लिए, /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"
  }

ऐसे डेवलपर के लिए स्वीकार किया गया रेट प्लान देखना जिसमें एपीआई का इस्तेमाल करके, एपीआई प्रॉडक्ट शामिल है

अगर आपको एपीआई प्रॉडक्ट वाले किसी डेवलपर के लिए स्वीकार किए गए किराये का प्लान देखना है, तो /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

एपीआई का इस्तेमाल करके, वे सभी रेट प्लान देखना जिन्हें डेवलपर स्वीकार करता है

डेवलपर के स्वीकार किए गए रेट प्लान देखने के लिए, /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans पर जीईटी अनुरोध जारी करें. इसमें {developer_id}, डेवलपर का आईडी है.

नतीजों को फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:

क्वेरी पैरामीटर ब्यौरा
all यह फ़्लैग बताता है कि सभी एपीआई पैकेज लौटाने हैं या नहीं. अगर इस नीति को false पर सेट किया जाता है, तो हर पेज के लिए लौटाए गए एपीआई पैकेज की संख्या size क्वेरी पैरामीटर से तय होती है. डिफ़ॉल्ट तौर पर, यह वैल्यू false होती है.
size हर पेज पर लौटाए गए एपीआई पैकेज की संख्या. डिफ़ॉल्ट वैल्यू 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
}

एपीआई का इस्तेमाल करके, रेट प्लान का ड्राफ़्ट मिटाना

रेट प्लान का ड्राफ़्ट मिटाने के लिए, /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} के लिए 'मिटाएं' अनुरोध जारी करें. यहां {plan_Id}, मिटाए जाने वाले रेट प्लान की पहचान करता है और {package_id} रेट प्लान के लिए एपीआई पैकेज की पहचान है. उदाहरण के लिए:

$ 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

रेट प्लान के लिए कॉन्फ़िगरेशन प्रॉपर्टी

एपीआई का इस्तेमाल करके रेट प्लान बनाते समय, ये कॉन्फ़िगरेशन सेटिंग तय की जा सकती हैं.

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
advance

यह ऑफ़र, सिर्फ़ बार-बार लगने वाले शुल्क के लिए मान्य है. ऐसा फ़्लैग जिससे यह पता चलता है कि बार-बार लगने वाला शुल्क, पहले से लिया जाएगा या नहीं. मान्य वैल्यू में ये शामिल हैं:

  • true - बार-बार लगने वाला शुल्क पहले ही लिया जाता है. उदाहरण के लिए, अगर अवधि एक महीने की है, तो पिछले बिलिंग महीने के खत्म होने पर जनरेट किए गए इनवॉइस पर, बार-बार लगने वाला शुल्क लिया जाएगा.
  • false - बार-बार होने वाला शुल्क, अवधि के खत्म होने के बाद लिया जाता है. उदाहरण के लिए, अगर अवधि एक महीने की है, तो मौजूदा बिलिंग महीना खत्म होने पर इनवॉइस पर, हर महीने लगने वाला शुल्क लिया जाता है. यह डिफ़ॉल्ट रूप से होता है.
 false नहीं
contractDuration

contractDurationType के साथ प्लान के लिए, कॉन्ट्रैक्ट की अवधि. उदाहरण के लिए, छह महीने की अवधि तय करने के लिए, contractDuration को 6 पर और contractDurationType को MONTH पर सेट करें.

 लागू नहीं नहीं
contractDurationType

contractDuration के साथ प्लान के लिए, कॉन्ट्रैक्ट की अवधि. मान्य वैल्यू में ये शामिल हैं:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 लागू नहीं नहीं
currency

रेट प्लान के लिए इस्तेमाल की जाने वाली मुद्रा. मुद्रा के लिए ISO 4217 कोड बताएं, जैसे कि डॉलर के लिए usd या स्विस फ़्रैंक के लिए chf.

 लागू नहीं हां
description

रेट प्लान की जानकारी.

 लागू नहीं हां
developer

डेवलपर आईडी (ईमेल पता). सिर्फ़ डेवलपर के लिए रेट प्लान के बारे में बताएं.

 लागू नहीं नहीं
developerCategory

डेवलपर कैटगरी आईडी. सिर्फ़ डेवलपर कैटगरी के रेट प्लान के लिए बताएं.

 लागू नहीं नहीं
displayName

रेट प्लान के लिए, उपयोगकर्ता के हिसाब से सही डिसप्ले नेम.

 लागू नहीं हां
earlyTerminationFee

अगर डेवलपर रिन्यूअल की अवधि से पहले ही प्लान खत्म कर देता है, तो एक बार लिया जाने वाला शुल्क लिया जाता है.

 लागू नहीं नहीं
endDate

प्लान खत्म होने की तारीख. इस तारीख के बाद, डेवलपर को किराये का प्लान नहीं दिखेगा. अगर आपको किसी तय तारीख पर रेट प्लान को खत्म नहीं करना है, तो endDate के लिए शून्य वैल्यू डालें.

किराया तय करने का प्लान, बताई गई तारीख को दिन के आखिर तक लागू रहेगा. उदाहरण के लिए, अगर आपको रेट प्लान की समयसीमा 1 दिसंबर, 2016 को खत्म करनी है, तो आपको endDate की वैल्यू 2016-11-30 पर सेट करनी चाहिए. इस मामले में, रेट प्लान की समयसीमा 30 नवंबर, 2016 को दिन के आखिर में खत्म हो जाएगी. साथ ही, 1 दिसंबर, 2016 को किए गए सभी अनुरोध ब्लॉक कर दिए जाएंगे.

ध्यान दें: एपीआई का इस्तेमाल करके रेट प्लान देखते समय, 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

रेट प्लान के लिए एपीआई प्रॉडक्ट बंडल आईडी.

 लागू नहीं नहीं
name

रेट प्लान का नाम.

 लागू नहीं हां
organization

रेट प्लान के लिए संगठन का आईडी.

 लागू नहीं हां
paymentDueDays

यह ऑफ़र, सिर्फ़ बार-बार लगने वाले शुल्क के लिए मान्य है. उन दिनों की संख्या जिनका शुल्क बकाया है. उदाहरण के लिए, वैल्यू को 30 पर सेट करें, ताकि यह बताया जा सके कि शुल्क 30 दिनों में देना है.

 लागू नहीं नहीं
proRate

यह ऑफ़र, सिर्फ़ बार-बार लगने वाले शुल्क के लिए मान्य है. यह फ़्लैग बताता है कि जब कोई डेवलपर एक महीने में किसी प्लान को शुरू या खत्म करता है, तो बार-बार लिया जाने वाला शुल्क प्रोरेट किया जाता है या नहीं. मान्य वैल्यू में ये शामिल हैं:

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

यह फ़्लैग तय करता है कि डेवलपर को रेट प्लान देखने के लिए पब्लिश करना चाहिए या नहीं. मान्य वैल्यू में ये शामिल हैं:

  • true - रेट प्लान पब्लिश करें.
  • false - रेट प्लान को पब्लिश न करें.
 लागू नहीं हां
ratePlanDetails

रेट प्लान की जानकारी (रेट प्लान की जानकारी के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें).

 लागू नहीं हां
recurringFee

जब तक डेवलपर प्लान खत्म नहीं कर देता, तब तक डेवलपर से वह शुल्क लगातार लिया जाता है.

 लागू नहीं नहीं
recurringStartUnit

सिर्फ़ तब मान्य है, जब recurringType को CALENDAR पर सेट किया गया हो. बार-बार लगने वाला शुल्क लेने के लिए महीने का दिन. उदाहरण के लिए, अगर बार-बार लगने वाला शुल्क हर महीने लिया जाता है और recurringStartUnit एक पर सेट है, तो हर महीने की पहली तारीख को बार-बार लगने वाला शुल्क लिया जाएगा.

 लागू नहीं नहीं
recurringType

बार-बार लगने वाले शुल्क के लिए शेड्यूल करें. मान्य वैल्यू में ये शामिल हैं:

  • CALENDAR - कैलेंडर के हिसाब से शेड्यूल किया गया है.
  • CUSTOM - पसंद के मुताबिक तारीख की सेटिंग के आधार पर शेड्यूल किया गया है.
 लागू नहीं नहीं
setUpFee

हर डेवलपर से प्लान शुरू होने की तारीख (यानी, जिस तारीख को डेवलपर प्लान खरीदता है) ऐसा शुल्क जो हर डेवलपर से लिया जाता है.

 लागू नहीं नहीं
startDate

प्लान शुरू होने की तारीख. डेवलपर इस तारीख से, रेट प्लान देख पाएंगे.

 लागू नहीं हां
type

रेट प्लान का टाइप. इनमें से कोई एक जानकारी दें:

  • STANDARD. सभी डेवलपर पर लागू होता है.
  • DEVELOPER_CATEGORY. चुनी गई कैटगरी के सभी डेवलपर पर लागू होता है.
  • DEVELOPER. किसी खास डेवलपर या कंपनी पर लागू होता है.
 लागू नहीं हां

रेट प्लान की जानकारी के लिए कॉन्फ़िगरेशन प्रॉपर्टी

रेट प्लान बनाते समय, ratePlanDetails कलेक्शन के हिस्से के तौर पर, इनमें से किसी भी कॉन्फ़िगरेशन की सही जानकारी दी जा सकती है.

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
aggregateFreemiumCounters

इस फ़्लैग से पता चलता है कि एग्रीगेट काउंटर चालू हैं या नहीं. इससे यह पता चलता है कि एपीआई प्रॉडक्ट का इस्तेमाल, मुफ़्त रेंज में किया जा रहा है या नहीं. किसी प्रॉडक्ट के लिए फ़्रीमियम प्लान सेट अप करने के लिए एग्रीगेट काउंटर चालू होने चाहिए. मान्य वैल्यू में ये शामिल हैं:

  • true - एग्रीगेट काउंटर चालू करें.
  • false - एग्रीगेट काउंटर चालू न करें.
 लागू नहीं नहीं
aggregateStandardCounters

ऐसा फ़्लैग जो यह बताता है कि इस्तेमाल के बैंड का पता लगाने के लिए एग्रीगेट काउंटर का इस्तेमाल किया गया है या नहीं. जैसे, रेट कार्ड प्लान के लिए वॉल्यूम बैंड. वैल्यू इनमें से कोई एक हो सकती है:

  • true - एग्रीगेट काउंटर का इस्तेमाल करें.
  • false - एग्रीगेट काउंटर का इस्तेमाल न करें.
 लागू नहीं नहीं
aggregateTransactions

ध्यान दें: फ़िलहाल, इस प्रॉपर्टी का इस्तेमाल कमाई करने के लिए नहीं किया जा रहा है और इसे अनदेखा किया जा सकता है.

 सही नहीं
currency

Currency.

 लागू नहीं नहीं
duration

कैलकुलेशन की फ़्रीक्वेंसी के लिए समयावधि और durationType, जहां duration की वैल्यू के तौर पर 1 से 24 के बीच की वैल्यू दी जा सकती है.

उदाहरण के लिए, दो महीने की कैलकुलेशन फ़्रीक्वेंसी तय करने के लिए, duration को 2 पर और durationType को MONTH पर सेट करें.

 लागू नहीं नहीं
durationType

duration के साथ, कैलकुलेशन की फ़्रीक्वेंसी के लिए समयावधि. सिर्फ़ MONTH ही मान्य वैल्यू है.

उदाहरण के लिए, duration देखें.

 लागू नहीं नहीं
freemiumDuration

freemiumDurationType के साथ, किसी एक एपीआई प्रॉडक्ट के लिए फ़्रीमियम अवधि की समयावधि. उदाहरण के लिए, यह बताने के लिए कि किसी एपीआई प्रॉडक्ट के लिए फ़्रीमियम अवधि 30 दिन है, freemiumDuration को 30 पर और freemiumDurationType को DAY पर सेट करें.

 लागू नहीं नहीं
freemiumDurationType

freemiumDuration के साथ, किसी एक एपीआई प्रॉडक्ट के लिए फ़्रीमियम अवधि की समयावधि. मान्य वैल्यू में ये शामिल हैं:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

उदाहरण के लिए, यह बताने के लिए कि एपीआई प्रॉडक्ट के फ़्रीमियम की अवधि 30 दिन है, freemiumDuration को 30 और freemiumDurationType को DAY पर सेट करें.

 लागू नहीं नहीं
freemiumUnit

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

 लागू नहीं नहीं
meteringType

रेट कार्ड प्लान के लिए चार्जिंग मॉडल. मान्य वैल्यू में ये शामिल हैं:

  • UNIT - समान दर पर चार्ज करने वाला मॉडल.
  • VOLUME - वॉल्यूम बैंड वाला चार्जिंग मॉडल.
  • STAIR_STEP - बंडल किया गया चार्जिंग मॉडल.
  • DEV_SPECIFIC - सूचना चार्ज करने वाला ऐसा मॉडल जिसमें बदलाव किया जा सकता है. रेवेन्यू के किसी दूसरे मॉडल के लिए मान्य नहीं है.
 लागू नहीं हाँ
organization

संगठन आईडी.

 लागू नहीं नहीं
paymentDueDays

पोस्टपेड डेवलपर के लिए पेमेंट की आखिरी तारीख. उदाहरण के लिए, वैल्यू को 30 पर सेट करके यह बताएं कि पेमेंट करने के लिए 30 दिनों की शर्त है.

 लागू नहीं नहीं
product

एपीआई प्रॉडक्ट की जानकारी, जैसे कि आईडी.

 लागू नहीं नहीं
ratePlanRates

रेट प्लान के रेट की जानकारी. जैसे, रेट प्लान किस तरह का है (REVSHARE या RATECARD), रेट कार्ड प्लान का रेट, रेवेन्यू के बंटवारे वाले प्लान से मिलने वाला रेवेन्यू का बंटवारा, और रेंज (शुरुआत की और आखिरी यूनिट, जिसके लिए रेट प्लान की दर लागू होती है).

 लागू नहीं हां
ratingParameter

रेट प्लान का आधार. रेट प्लान, लेन-देन या किसी कस्टम एट्रिब्यूट पर आधारित होता है. मान्य वैल्यू में ये शामिल हैं:

  • VOLUME - किराये की योजना, लेन-देन की संख्या के हिसाब से तय होती है.
  • custom_attribute - उस कस्टम एट्रिब्यूट का नाम जिसके बारे में एपीआई प्रॉडक्ट के लिए, ट्रांज़ैक्शन रिकॉर्ड करने की नीति में बताया गया है . यह नाम सिर्फ़ रेट कार्ड प्लान के लिए मान्य है. कस्टम एट्रिब्यूट के नाम को VOLUME के तौर पर नहीं दिखाया जा सकता.
 VOLUME हां
ratingParameterUnit

ratingParameter. Only required if रेटिंग पैरामीटर पर लागू होने वाली यूनिट को कस्टम एट्रिब्यूट पर सेट किया गया है. इसका मतलब है कि यह वॉल्यूम पर सेट नहीं है.

 लागू नहीं हां
revenueType

रेवेन्यू के बंटवारे के प्लान में रेवेन्यू के हिस्से का आधार. मान्य वैल्यू में ये शामिल हैं:

  • GROSS - आय का बंटवारा, लेन-देन की कुल कीमत के प्रतिशत पर आधारित होता है.
  • NET - आय का बंटवारा, लेन-देन की कुल कीमत के प्रतिशत के हिसाब से होता है.
 लागू नहीं नहीं
type

रेट प्लान का टाइप. मान्य वैल्यू में ये शामिल हैं:

  • REVSHARE - आय के बंटवारे का मॉडल.
  • RATECARD - रेट कार्ड का मॉडल.
  • REVSHARE_RATECARD - आय के बंटवारे और रेट कार्ड का मॉडल.
  • USAGE_TARGET - सूचना का ऐसा मॉडल जिसे अडजस्ट किया जा सकता है.

अलग-अलग तरह के रेट के बारे में ज़्यादा जानने के लिए, ऐसे रेट प्लान देखें जिन्हें इस्तेमाल किया जा सकता है.

 लागू नहीं हां