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

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

परिचय

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

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

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

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

Edge

Edge UI का इस्तेमाल करके, रेवेन्यू शेयर करने का प्लान कॉन्फ़िगर करने के लिए, दर प्लान बनाते या बदलते समय, रेवेन्यू शेयर या रेट कार्ड और रेवेन्यू शेयर वाला दर प्लान टाइप चुनें. इसके बाद, रेवेन्यू शेयर सेक्शन में जाकर यह जानकारी कॉन्फ़िगर करें:

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

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

पहले बैंड की ऊपरी सीमा तय करें. उदाहरण के लिए, 1,000 तक (निचली सीमा, 0 से ज़्यादा पर पहले से सेट होती है). ज़्यादा बैंड जोड़ने के लिए, +नया पर क्लिक करें. कुल रेवेन्यू इस लेवल से ऊपर जाने के बाद हुए सभी लेन-देन को दिखाने के लिए, फ़ाइनल बैंड की ऊपरी सीमा को खाली छोड़ दें.

उदाहरण के लिए, अगर आपने रेवेन्यू बैंड सेक्शन में दो रेवेन्यू बैंड (>0-1000 और 1000 और इससे ज़्यादा) तय किए हैं, तो >0-1000 रेवेन्यू बैंड के लिए 80.5555 और 1000 और इससे ज़्यादा रेवेन्यू बैंड के लिए 90.5 डाला जा सकता है. यह भी मान लें कि मुद्रा अमेरिकी डॉलर में है. इसके बाद, जिन लेन-देन से 1,000 डॉलर तक का रेवेन्यू मिलता है उनके लिए, रेवेन्यू का बंटवारा लेन-देन की कीमत का 80.5555% होता है. साथ ही, जिन लेन-देन से 1,000 डॉलर से ज़्यादा का रेवेन्यू मिलता है उनके लिए, रेवेन्यू का बंटवारा लेन-देन की कीमत का 90.5% होता है.

Classic Edge (Private Cloud)

Classic Edge UI का इस्तेमाल करके, रेवेन्यू शेयर करने के प्लान कॉन्फ़िगर करने के लिए:

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

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

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

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

    रेवेन्यू के हिस्से वाली विंडो खुल जाएगी.

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

    शेयर करने के फ़िक्स्ड मॉडल के लिए:

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

    फ़ील्ड ब्यौरा
    ऑपरेटर (या संगठन)

    आपके संगठन का नाम. यह फ़ील्ड, संगठन की प्रोफ़ाइल में मौजूद ऑपरेटर (या संगठन) फ़ील्ड की वैल्यू का इस्तेमाल करके पहले से सेट होता है.

    देश

    आपके संगठन का देश. यह फ़ील्ड, संगठन की प्रोफ़ाइल में मौजूद देश फ़ील्ड की वैल्यू का इस्तेमाल करके पहले से सेट होता है.

    मुद्रा

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

    कीमत का टाइप

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

    तय शेयर %

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

    शेयर करने के फ़्लेक्सिबल मॉडल के लिए:

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

    रेवेन्यू शेयर की सामान्य जानकारी वाली विंडो में, यह जानकारी डालें:

    फ़ील्ड ब्यौरा
    एग्रीगेशन का आधार

    वह समयावधि जिसके लिए रेवेन्यू को एग्रीगेट किया जाता है. कुल रेवेन्यू का इस्तेमाल, हर लेन-देन के लिए रेवेन्यू बैंड और लागू होने वाले रेवेन्यू शेयर के प्रतिशत का हिसाब लगाने के लिए किया जाता है. महीनों की संख्या चुनें. यह संख्या 1 से 12 के बीच होनी चाहिए.

    रेवेन्यू बैंड

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

    पहले बैंड की ऊपरी सीमा तय करें. उदाहरण के लिए, 1,000 तक (निचली सीमा, 0 से ज़्यादा पर पहले से सेट है). दूसरा बैंड जोड़ने के लिए, + पर क्लिक करें. उदाहरण के लिए, 1,000 से ज़्यादा और 2,000 तक. ज़्यादा बैंड जोड़ने के लिए, + पर क्लिक करें. कुल रेवेन्यू इस लेवल से ऊपर जाने के बाद, सभी लेन-देन दिखाने के लिए, फ़ाइनल बैंड की ऊपरी सीमा को खाली छोड़ा जा सकता है.

    कीमत
    ऑपरेटर (या संगठन)

    आपके संगठन का नाम. यह फ़ील्ड, संगठन की प्रोफ़ाइल में मौजूद ऑपरेटर (या संगठन) फ़ील्ड की वैल्यू का इस्तेमाल करके पहले से सेट होता है.

    देश

    आपके संगठन का देश. यह फ़ील्ड, संगठन की प्रोफ़ाइल में मौजूद देश फ़ील्ड की वैल्यू का इस्तेमाल करके पहले से सेट होता है.

    मुद्रा

    वह "आधार" या हिसाब रखने वाली मुद्रा जिसका इस्तेमाल आपका संगठन करता है. यह फ़ील्ड, संगठन की प्रोफ़ाइल में मौजूद मुद्रा फ़ील्ड की वैल्यू का इस्तेमाल करके पहले से सेट होता है.

    कीमत का टाइप

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

    रेवेन्यू बैंड के लिए शेयर का प्रतिशत

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

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

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

किराये का प्लान बनाते समय, रेवेन्यू के बंटवारे के प्लान की जानकारी दी जाती है. /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 और आखिरी यूनिट के तौर पर 1000 तय की है, तो रेवेन्यू बैंड में, तय की गई मुद्रा में 0 से ज़्यादा और 1000 तक का ट्रांज़ैक्शन रेवेन्यू शामिल होगा. अगर मुद्रा अमेरिकी डॉलर है, एग्रीगेशन का आधार एक महीना है, और रेवेन्यू बैंड के लिए प्रतिशत 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"
}