Как указать сведения о плане с комиссиями

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Введение

В тарифном плане с комиссиями разработчик платит только комиссии поставщика API, указанные в тарифном плане, например единовременную плату за настройку или комиссию за досрочное расторжение. (Подробнее о том, как указать сборы в тарифном плане, рассказывается в статье Как добавить сборы в тарифный план.) Дополнительные комиссии за транзакции не взимаются.

При создании плана можно указать условия продления, то есть период времени, на который будет продлеваться подписка. Монетизация автоматически продлевает тарифный план в конце периода продления (если разработчик не отменит его). Если разработчик расторгает тарифный план до окончания срока действия и при этом взимается комиссия за досрочное расторжение, то эта комиссия будет списана с разработчика.

Инструменты

Добавлять сведения о планах с комиссиями можно только с помощью API монетизации. Для этого задайте нужные свойства в теле запроса при вызове ресурса /organizations/{org_name}/monetization-packages/{package_id}/rate-plans (когда вы создаете тарифный план).

Как указать сведения о плане с комиссиями с помощью API

При создании тарифного плана вы указываете только сведения о комиссиях. Вы указываете сведения в теле запроса.

Например, следующий код создает тарифный план, включающий только сборы. В плане указана плата за досрочное расторжение (20 долларов США), плата за настройку (10 долларов США) и регулярная плата (5 долларов США в месяц). Комиссии необходимо оплатить в течение 30 дней. При этом регулярная комиссия взимается в полном объеме (то есть не пропорционально). Срок продления – 6 месяцев. (Спецификации, связанные с комиссией, а также спецификации срока продления выделены.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Standard fees only plan",
     "advance": "false",
     "contractDuration": "6",
     "contractDurationType": "MONTH",
      "currency": {
      "id" : "usd"
     },
     "earlyTerminationFee": "20",
     "description": "Standard fees only plan",
     "displayName": "Standard fees only plan",
     "frequencyDuration": 1,
     "frequencyDurationType": "MONTH",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "prorate": "false",
     "paymentDueDays": "30",
     "published": "true",  
     "ratePlanDetails": [],   
     "recurringFee": "5",
     "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

Обратите внимание, что свойство ratePlanDetails пустое. Для тарифного плана с комиссией не нужно указывать никаких дополнительных сведений, кроме размера комиссии и периода продления.

Ответ должен выглядеть следующим образом (показана только часть ответа): 
{
  "advance" : false,
  "contractDuration" : 6,
  "contractDurationType" : "MONTH",
  "currency" : {    
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Standard fees only plan",
  "displayName" : "Standard fees only plan",
  "earlyTerminationFee" : 20,
  "freemiumDuration" : 0,
  "freemiumDurationType" : "MONTH",
  "freemiumUnit" : 0,
  "frequencyDuration" : 1,
  "frequencyDurationType" : "MONTH",
  "id" : "location_standard_fees_only_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"
  },
  "name" : "Standard fees only plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ ],
  "recurringFee" : 5,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-07-30 00:00:00",
  "type" : "STANDARD"
}

Полный список вариантов тарифных планов приведен в разделе Настройки конфигурации тарифного плана.

Дальнейшие действия

При необходимости добавьте бесплатный тарифный план. Подробнее о том, как добавить бесплатный план…

После того как вы создадите тарифный план и укажете его детали, вы сможете опубликовать его или сохранить как черновик. Подробнее о том, как управлять тарифными планами и публиковать их…