درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
مقدمه
در طرح سهم درآمد، ارائه‌دهنده API درصدی از درآمد تولیدشده از هر تراکنش را با توسعه‌دهنده تقسیم می‌کند (براساس قیمت ناخالص یا خالص تراکنش). هنگام ایجاد یک طرح توزیع سهم درآمد، باید یک مدل توزیع را مشخص کنید که می‌تواند ثابت یا انعطاف‌پذیر باشد، و همچنین یک مبنای قیمت‌گذاری (مثلاً اینکه توزیع سهم درآمد براساس قیمت ناخالص یا خالص یک تراکنش باشد). وقتی خط‌مشی ضبط تراکنش را ایجاد می‌کنید، قیمت ناخالص یا خالص تراکنش را تعیین می‌کنید.
در مدل توزیع ثابت، درصد ثابتی از درآمد تولیدشده از هر تراکنش (براساس قیمت ناخالص یا خالص تراکنش) را با توسعه‌دهنده تقسیم می‌کنید. در مدل هم‌رسانی انعطاف‌پذیر، درصد متغیری از درآمد را با توسعه‌دهنده هم‌رسانی می‌کنید. سهم درآمد به درآمد تولیدشده در یک دوره زمانی بستگی دارد. درصد استفاده‌شده در محاسبه سهم درآمد ممکن است براساس مقدار درآمد تولیدشده از تراکنش‌ها متفاوت باشد.
مشخص کردن جزئیات طرح سهم درآمد بااستفاده از واسط کاربر
طرح‌های تقسیم درآمد را همان‌طور که در زیر توضیح داده شده است پیکربندی کنید.
Edge
برای پیکربندی طرح توزیع سهم درآمد بااستفاده از «میانای کاربری Edge»، هنگام ایجاد یا ویرایش طرح نرخ، نوع طرح نرخ توزیع سهم درآمد یا جدول نرخ و توزیع سهم درآمد را انتخاب کنید و در بخش توزیع سهم درآمد اطلاعات زیر را پیکربندی کنید:
| فیلد | شرح |
| مدل محاسبه | یکی از انواع قیمت‌گذاری زیر را انتخاب کنید:
|
| بسامد محاسبه | دوره زمانی که حجم تراکنش‌ها (یا حجم مربوط به مشخصه سفارشی) در آن محاسبه می‌شود. تعداد ماه‌ها را انتخاب کنید (۱ تا ۲۴ ماه). |
| درحال هم‌رسانی مدل | یکی از مدل‌های سهم درآمد زیر را انتخاب کنید:
|
| سهم درآمد ثابت | برای مدل توزیع ثابت، درصد استفاده‌شده برای محاسبه سهم درآمد را مشخص می‌کند. عدد اعشاری (با حداکثر چهار رقم اعشار) وارد کنید. برای مثال، اگر ۸۰٫۵۵۵۵ را وارد کنید، سهم درآمد ۸۰٫۵۵۵۵٪ است، یعنی به‌عنوان ارائه‌دهنده API، شما ۸۰٫۵۵۵۵٪ از قیمت کسرشده برای هر تراکنش را به توسعه‌دهنده پرداخت می‌کنید. |
| بخش‌های سهم درآمد | برای مدل هم‌رسانی انعطاف‌پذیر، یک یا چند محدوده درآمد تراکنش (هر محدوده یک «باند درآمد» است). برای هر گروه درآمدی می‌توان درصد سهم درآمدی تعیین کرد. تراکنش‌ها براساس پایه تجمیع تجمیع می‌شوند تا درآمد کل و گروه درآمد برای تراکنش محاسبه شود. درصد سهم درآمد اعمال‌شده بر هر تراکنش به گروه درآمد آن بستگی دارد. حد بالای اولین دسته را مشخص کنید، برای مثال، تا ۱۰۰۰ (حد پایین ازپیش‌تنظیم‌شده و بزرگ‌تر از ۰ است). برای افزودن گروه‌های بیشتر، روی +جدید کلیک کنید. حد بالایی گروه نهایی را خالی بگذارید تا نشان دهید همه تراکنش‌ها پس‌از اینکه درآمد کل از این سطح فراتر رفت انجام شده است. برای مثال، اگر دو گروه درآمدی را در بخش «گروه درآمدی» مشخص کنید (>0-1000، و 1000 و بالاتر)، ممکن است برای گروه درآمدی >0-1000 مقدار 80.5555 و برای گروه درآمدی 1000 و بالاتر مقدار 90.5 را وارد کنید. همچنین فرض کنید که ارز به دلار امریکا است. سپس برای تراکنش‌هایی که تا ۱۰۰۰ دلار درآمد ایجاد می‌کنند، سهم درآمد ۸۰٫۵۵۵۵٪ از قیمت تراکنش است، و برای تراکنش‌هایی که بیش از ۱۰۰۰ دلار درآمد ایجاد می‌کنند، سهم درآمد ۹۰٫۵٪ از قیمت تراکنش است. |
Classic Edge (ابر خصوصی)
برای پیکربندی طرح‌های توزیع سهم درآمد بااستفاده از «واسط کاربر Edge کلاسیک»:
- مراحل ایجاد طرح نرخ را دنبال کنید.
- برای پیکربندی مدل درآمد، سهم درآمد را در منو کرکره‌ای «نوع طرح نرخ» انتخاب کنید.
- اگر بسته API انتخاب‌شده شامل چندین محصول API است، یکی از گزینه‌های زیر را انتخاب کنید:
توجه: اگر بسته API شامل یک محصول API باشد، می‌توانید از این مرحله رد شوید.
- طرح‌های مختص محصول برای پیکربندی جزئیات طرح نرخ برای هر محصول API به‌صورت جداگانه.
- طرح عمومی برای همه محصولات برای پیکربندی جزئیات طرح نرخ برای همه محصولات API.
- برای طرح نرخ عمومی یا برای هر طرح نرخ مختص محصول API، روی توزیع سهم درآمد کلیک کنید.
توجه: هنگام پیکربندی طرح‌های مختص محصول API، باید طرح سهم درآمدی را برای هر محصول API به‌صورت جداگانه پیکربندی کنید.
پنجره «سهم درآمد» باز می‌شود.
- یکی از مدل‌های هم‌رسانی زیر را انتخاب کنید:
- ثابت: در این مدل، ارائه‌دهنده API درصد ثابتی از درآمد تولیدشده از هر تراکنش را با توسعه‌دهنده هم‌رسانی می‌کند (براساس قیمت ناخالص یا خالص تراکنش).
- انعطاف‌پذیر: در این مدل، ارائه‌دهنده API درصد متغیری از درآمد را با توسعه‌دهنده هم‌رسانی می‌کند. سهم درآمد به درآمد تولیدشده در یک دوره زمانی بستگی دارد. درصد استفاده‌شده در محاسبه سهم درآمد ممکن است براساس مقدار درآمد تولیدشده از تراکنش‌ها متفاوت باشد.
برای مدل هم‌رسانی ثابت:
اگر مدل توزیع سهم درآمد ثابت را انتخاب کنید، اطلاعات زیر را در بخش «قیمت‌گذاری» پنجره «توزیع سهم درآمد عمومی» وارد کنید:
فیلد شرح اپراتور (یا سازمان) نام سازمان شما. این فیلد بااستفاده از مقدار فیلد «اپراتور» (یا «سازمان») در نمایه سازمان ازپیش تنظیم شده است.
کشور کشور محل فعالیت سازمان شما. این فیلد بااستفاده از مقدار فیلد «کشور» در نمایه سازمان ازپیش تنظیم شده است.
واحد پول واحد پول «پایه» یا حسابداری که شرکتتان استفاده می‌کند. این فیلد بااستفاده از مقدار فیلد «واحد پول» در نمایه سازمان ازپیش تنظیم شده است.
نوع قیمت‌گذاری مبنای سهم درآمد. «ناخالص» یا «خالص» را انتخاب کنید. اگر «ناخالص» را انتخاب کنید، سهم درآمد براساس درصدی از قیمت ناخالص تراکنش است. اگر «خالص» را انتخاب کنید، سهم درآمد براساس درصدی از قیمت خالص تراکنش محاسبه می‌شود. توجه: هنگام ایجاد خط‌مشی ضبط تراکنش، قیمت ناخالص یا خالص تراکنش را تعیین می‌کنید.
درصد سهم ثابت درصدی که برای محاسبه سهم درآمد استفاده می‌شود. عدد اعشاری (با حداکثر چهار رقم اعشار) وارد کنید. برای مثال، اگر ۸۰٫۵۵۵۵ را وارد کنید، سهم درآمد ۸۰٫۵۵۵۵٪ است، یعنی به‌عنوان ارائه‌دهنده API، ۸۰٫۵۵۵۵٪ از قیمت کسرشده برای هر تراکنش را به توسعه‌دهنده پرداخت می‌کنید.
برای مدل هم‌رسانی انعطاف‌پذیر:
اگر مدل هم‌رسانی انعطاف‌پذیر را انتخاب کنید، متوجه خواهید شد که پنجره «سهم درآمد عمومی» فیلدهای بیشتری را نمایش می‌دهد. از این فیلدها برای مشخص کردن مبنایی برای انبوهش و برای مشخص کردن «نوارهای درآمدی» استفاده می‌کنید، یعنی محدوده‌های درآمد تولیدشده از تراکنش که می‌توانید درصد سهم درآمد مختلفی را برای آن‌ها اعمال کنید.
اطلاعات زیر را در پنجره «توزیع سهم درآمد عمومی» وارد کنید:
فیلد شرح مبنای انبوهش دوره زمانی که درآمد در آن جمع‌آوری می‌شود. از درآمد تجمیعی برای محاسبه گروه درآمدی هر تراکنش (و درصد سهم درآمد قابل اعمال) استفاده می‌شود. تعداد ماه‌ها (بین ۱ تا ۱۲) را انتخاب کنید.
باند درآمد یک یا چند محدوده درآمد تراکنش (هر محدوده یک «باند درآمدی» است). به هر باند درآمدی می‌توان درصد سهم درآمد اختصاص داد (این درصد را در فیلد «باند درآمدی» در بخش «قیمت‌گذاری» تنظیم می‌کنید.) تراکنش‌ها براساس پایه تجمیع برای محاسبه درآمد کل و گروه درآمدی برای تراکنش تجمیع می‌شوند. درصد سهم درآمد اعمال‌شده بر هر تراکنش به بازه درآمد آن بستگی دارد.
حد بالایی اولین دسته را مشخص کنید، برای مثال، تا ۱۰۰۰ (حد پایین به‌صورت پیش‌فرض روی بیشتر از ۰ تنظیم شده است). برای افزودن گروه دوم، برای نمونه، بزرگ‌تر از ۱۰۰۰ و تا ۲۰۰۰، روی + کلیک کنید. برای افزودن گروه‌های بیشتر، روی + کلیک کنید. می‌توانید حد بالای باند نهایی را خالی بگذارید تا نشان دهید همه تراکنش‌ها پس‌از اینکه درآمد کل از این سطح فراتر رفت اعمال می‌شود.
قیمت‌گذاری اپراتور (یا سازمان) نام سازمان شما. این فیلد بااستفاده از مقدار فیلد «اپراتور» (یا «سازمان») در نمایه سازمان ازپیش تنظیم شده است.
کشور کشور محل فعالیت سازمان شما. این فیلد بااستفاده از مقدار فیلد «کشور» در نمایه سازمان ازپیش تنظیم شده است.
واحد پول واحد پول «پایه» یا حسابداری که سازمانتان استفاده می‌کند. این فیلد بااستفاده از مقدار فیلد «واحد پول» در نمایه سازمان ازپیش تنظیم شده است.
نوع قیمت‌گذاری مبنای سهم درآمد. «ناخالص» یا «خالص» را انتخاب کنید. اگر «ناخالص» را انتخاب کنید، سهم درآمد براساس درصدی از قیمت ناخالص تراکنش است. اگر «خالص» را انتخاب کنید، سهم درآمد براساس درصدی از قیمت خالص تراکنش محاسبه می‌شود. توجه: هنگام ایجاد خط‌مشی ضبط تراکنش، قیمت ناخالص یا خالص تراکنش را تعیین می‌کنید.
درصد سهم برای «گروه‌های درآمدی» درصد استفاده‌شده برای محاسبه سهم درآمد برای تراکنش‌ها در هر باند درآمدی. درصدی را برای هر باند مشخص می‌کنید. عدد اعشاری (با حداکثر چهار رقم اعشار) وارد کنید. برای مثال، اگر دو گروه درآمدی را در بخش «گروه درآمدی» مشخص کنید (>0-1000، و 1000 و بالاتر)، ممکن است 80.5555 را برای گروه درآمدی >0-1000، و 90.5 را برای گروه درآمدی 1000 و بالاتر وارد کنید. همچنین فرض کنید واحد پول به دلار امریکا است. سپس برای تراکنش‌هایی که تا ۱۰۰۰ دلار درآمد ایجاد می‌کنند، سهم درآمد ۸۰٫۵۵۵۵٪ از قیمت تراکنش است و برای تراکنش‌هایی که بیش از ۱۰۰۰ دلار درآمد ایجاد می‌کنند، سهم درآمد ۹۰٫۵٪ از قیمت تراکنش است.
- روی اعمال و بستن کلیک کنید تا جزئیات سهم درآمد ذخیره شود و به پنجره «طرح» «نرخ استاندارد» برگردید.
- برای طرح‌های نرخ ویژه محصول «میانای برنامه‌سازی کاربردی»، جزئیات طرح نرخ را برای محصولات «میانای برنامه‌سازی کاربردی» اضافی، درصورت نیاز، پیکربندی کنید.
مشخص کردن جزئیات طرح سهم درآمد بااستفاده از API
جزئیات طرح سهم درآمد را هنگام ایجاد طرح نرخ مشخص می‌کنید. جزئیات را در
دارایی ratePlanDetails در بدنه درخواست در تماس با
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans مشخص می‌کنید. آنچه در دارایی ratePlanDetails مشخص می‌کنید، به مدل هم‌رسانی که انتخاب می‌کنید بستگی دارد:
ثابت یا انعطاف‌پذیر.
مشخص کردن جزئیات طرح سهم درآمد برای یک مدل توزیع ثابت
برای پیاده‌سازی مدل توزیع ثابت، موارد زیر را در جزئیات طرح نرخ مشخص می‌کنید:
- پارامتر رده‌بندی که نشان می‌دهد طرح نرخ براساس تراکنش‌ها است
(
VOLUME).VOLUMEپیش‌فرض است. - نوعی اندازه‌گیری (
UNIT) که نشان می‌دهد سهم درآمد به‌ازای هر واحد ثابت است (یعنی براساس حجم تراکنش‌ها نیست، همان‌طور که در مدل توزیع سهم درآمد انعطاف‌پذیر این‌گونه است). - نوع درآمد (
GROSSیاNET). این نشان می‌دهد که آیا توزیع سهم درآمد براساس قیمت ناخالص یا خالص تراکنش است. - دوره سررسید پرداخت (برای مثال، ۳۰ روز).
- شناسه سازمان شما.
- واحد پول «پایه» یا حسابداری که شرکتتان استفاده می‌کند.
- نرخ طرح نرخ که جزئیاتی درباره نحوه محاسبه سهم درآمد ارائه می‌دهد. چون مدل هم‌رسانی براساس نرخ ثابت است، فقط یک نرخ طرح نرخ را مشخص می‌کنید.
برای فهرست کامل دارایی‌های جزئیات طرح نرخ، دارایی‌های پیکربندی برای جزئیات طرح نرخ را ببینید.
در نرخ طرح نرخ، موارد زیر را مشخص می‌کنید:
- نوع نرخ طرح نرخ (
REVSHARE). - درصدی که برای محاسبه سهم درآمد استفاده می‌شود. برای مثال، اگر ۸۰٫۵۵۵۵ را مشخص کنید، سهم درآمد ۸۰٫۵۵۵۵٪ است، یعنی به‌عنوان ارائه‌دهنده API، ۸۰٫۵۵۵۵٪ از قیمت کسرشده برای هر تراکنش را به توسعه‌دهنده پرداخت می‌کنید (یا اگر براساس مشخصه سفارشی مثل تعداد بایت‌های منتقل‌شده در تراکنش باشد، ۸۰٫۵۵۵۵٪ از قیمت کسرشده برای انتقال تعداد مشخص‌شده بایت را به توسعه‌دهنده پرداخت می‌کنید).
- واحد شروع اعمال نرخ (
0). این یعنی نرخ برای هر تراکنش اعمال می‌شود، از اولین تراکنش شروع می‌شود.
برای فهرست کامل دارایی‌های طرح نرخ، دارایی‌های پیکربندی برای طرح‌های نرخ را ببینید.
برای مثال، کد زیر یک طرح توزیع سهم درآمد با مدل توزیع ثابت ایجاد می‌کند. درصد سهم درآمد ۸۰٫۵۵۵۵٪ است. سهم درآمد براساس قیمت خالص تراکنش است. قرارداد از ۱۵ سپتامبر ۲۰۱۳ معتبر است و پرداخت باید ظرف ۳۰ روز انجام شود. (جزئیات مربوط به سهم درآمد برجسته شده است.)
$ 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). این نشان می‌دهد که آیا توزیع سهم درآمد براساس قیمت ناخالص یا خالص تراکنش است. - دوره سررسید پرداخت (برای مثال، ۳۰ روز).
- شناسه سازمان شما.
- واحد پول «پایه» یا حسابداری که شرکتتان استفاده می‌کند.
- مدت و نوع مدت که با هم دوره زمانی را که درآمد در آن جمع‌آوری می‌شود مشخص می‌کنند (این دوره زمانی «پایه تجمیع» نیز نامیده می‌شود). تراکنش‌ها براساس پایه تجمیع (برای مثال، ۱ ماه) تجمیع می‌شوند تا درآمد کل و گروه درآمدی ذی‌ربط محاسبه شود. درصد سهم درآمد اعمال‌شده بر هر تراکنش به گروه درآمد آن بستگی دارد.
- شمارنده‌های تجمیعی که برای تعیین گروه درآمدی قابل اعمال استفاده می‌شوند.
برای فهرست کامل دارایی‌های جزئیات طرح نرخ، دارایی‌های پیکربندی برای جزئیات طرح نرخ را ببینید.
برای هر نرخ طرح نرخ، موارد زیر را مشخص می‌کنید:
- نوع نرخ طرح نرخ برای گروه درآمدی (
REVSHARE). - درصدی که برای محاسبه سهم درآمد برای گروه درآمد استفاده می‌شود. برای مثال، اگر ۸۰٫۵۵۵۵ را مشخص کنید، سهم درآمد برای گروه درآمدی ٪۸۰٫۵۵۵۵ است، یعنی به‌عنوان ارائه‌دهنده API، ٪۸۰٫۵۵۵۵ از قیمت کسرشده برای هر تراکنش در آن گروه درآمدی را به توسعه‌دهنده پرداخت می‌کنید.
- واحد شروع و پایان گروه درآمد. واحد شروع حد پایین یک گروه درآمدی را مشخص می‌کند و واحد پایان حد بالای گروه درآمدی را مشخص می‌کند. برای
مثال، اگر واحد شروع را ۰ و واحد پایان را ۱۰۰۰ مشخص کنید، گروه درآمدی
درآمد تراکنش بزرگ‌تر از ۰ و تا ۱۰۰۰ را به ارز مشخص‌شده پوشش می‌دهد. اگر واحد پول دلار امریکا باشد، مبنای تجمیع ۱ ماه باشد، و درصد برای گروه درآمدی ۸۰٫۵۵۵۵٪ باشد، در این‌صورت برای تراکنش‌هایی که تا ۱۰۰۰ دلار درآمد در یک ماه ایجاد می‌کنند، سهم درآمد ۸۰٫۵۵۵۵٪ از قیمت تراکنش است.
اگر واحد پایانی برای گروه درآمد نهایی مشخص نکنید، درصد سهم برای آن گروه به همه تراکنش‌ها پس‌از اینکه درآمد کل از واحد شروع برای آن گروه فراتر رفت اعمال می‌شود. برای مثال، اگر واحد شروع برای آخرین دسته ۱۰۰۰ (فرض کنید دلار امریکا) باشد و واحد پایانی برای آن دسته مشخص نکنید، درصد درآمد برای آن دسته به همه تراکنش‌های بالای ۱۰۰۰ دلار درآمد درطول دوره تجمعی اعمال می‌شود.
برای فهرست کامل دارایی‌های طرح نرخ، دارایی‌های پیکربندی برای طرح‌های نرخ را ببینید.
برای مثال، کد زیر یک طرح توزیع سهم درآمد با مدل توزیع انعطاف‌پذیر ایجاد می‌کند. این دو گروه درآمدی را مشخص می‌کند. اولین دسته شامل درآمد تراکنش بیشتر از تا ۱۰۰۰ دلار امریکا است. باند دوم درآمد تراکنش بالای ۱۰۰۰ دلار امریکا را پوشش می‌دهد. درصد سهم درآمد برای گروه درآمدی اول ۸۰٫۵۵۵۵٪ و برای گروه درآمدی دوم ۹۰٫۵٪ است. سهم درآمد براساس قیمت خالص تراکنش است. مبنای انبوهش ۱ ماه است. دوره قرارداد از ۱۵ سپتامبر ۲۰۱۳ شروع می‌شود و پرداخت باید ظرف ۳۰ روز انجام شود. (جزئیات مربوط به سهم درآمد برجسته شده است.)
$ 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" }