Настроить тарифный план

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

Введение

В тарифном плане разработчик взимает плату за каждую транзакцию. Для этого типа плана вам необходимо предоставить дополнительную информацию, такую ​​как модель взимания платы и стоимость модели взимания платы.

При желании вы можете указать бесплатный план для отдельных продуктов (а не для пакета API) — это можно сделать только для плана для конкретного продукта.

Когда взимаются регулярные сборы и сбрасываются пакетные планы?

Тарифные планы могут включать периодические сборы, а также пакеты API (планы Volume Banded и Bundle), оба из которых предусматривают определенное время, когда взимаются комиссии, а пакеты пакетов сбрасываются до нуля. В следующей таблице описано, когда взимаются периодические сборы и сбрасывается количество пакетов. Если приложениям разработчика запрещено выполнять дальнейшие вызовы API, поскольку они достигли определенного предела транзакций, в этот момент счетчик вызовов API сбрасывается до нуля, и приложения могут снова начать выполнять вызовы.

Настройка тарифных планов с помощью пользовательского интерфейса

Настройте тарифные планы, как описано ниже.

Настройка тарифного плана с помощью API

Настройте детали тарифного плана с помощью API, как описано в следующих разделах.

Указание деталей тарифного плана с помощью API

Подробности тарифного плана вы указываете при создании тарифного плана. Вы указываете детали в ratePlanDetails в теле запроса при вызове /organizations/{org_name}/monetization-packages/{package_id}/rate-plans . То, что вы указываете в ratePlanDetails , зависит от выбранной вами модели взимания платы: фиксированная ставка, диапазон объема или пакеты.

Указание модели взимания фиксированной ставки

Чтобы реализовать модель взимания фиксированной ставки, вы указываете в деталях тарифного плана следующее:

• Параметр рейтинга, указывающий, что тарифный план основан на транзакциях ( VOLUME ) или на основе настраиваемого атрибута (например, MINT_CUSTOM_ATTRIBUTE_1 ). VOLUME — значение по умолчанию.
• Тип измерения ( UNIT ), указывающий, что ставка фиксирована за единицу (т. е. она не зависит от объема транзакций, как в случае с моделью начисления по объему или пакетам).
• Срок оплаты (например, 30 дней).
• Идентификатор вашей организации.
• «Базовая» или учетная валюта, которую использует ваша компания.
• Тариф тарифного плана, который предоставляет подробную информацию о том, как рассчитывается тариф. Поскольку модель начисления платы основана на фиксированной ставке, вы указываете только одну ставку тарифного плана.

В тарифе тарифного плана вы указываете:

• Тип тарифного плана ( RATECARD ).
• Ставка по плану. Например, если вы указываете 0,10, а валютой являются доллары США, с разработчика взимается плата в размере 0,10 доллара США за каждую транзакцию (или, если на основе пользовательского атрибута, такого как количество байтов, переданных в транзакции, с разработчика взимается плата в размере 0,10 доллара США за передачу указанное количество байт).
• Начальная единица применения ставки ( 0 ). Это означает, что ставка применяется к каждой транзакции, начиная с первой транзакции.

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

Например, в следующем примере создается тарифный план с моделью фиксированной оплаты. Ставка установлена ​​на уровне $0,10 за каждую транзакцию. Оплата производится в течение 30 дней. (Подробности, связанные с прейскурантом, выделены.)

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "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": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "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" \
-u email:password

Указание модели зарядки с ограничением объема

В модели с диапазоном объема вы указываете детали тарифного плана, которые включают одну или несколько ставок тарифного плана. Каждая ставка применяется к «диапазону объема», то есть диапазону объема транзакции (или диапазону, основанному на настраиваемом атрибуте, таком как количество переданных байт). Этот тип плана обычно создается для того, чтобы побудить разработчиков генерировать большие объемы, предлагая скидки для более высоких диапазонов объема.

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

• Параметр рейтинга, указывающий, что тарифный план основан на транзакциях ( VOLUME ) или на основе настраиваемого атрибута (например, CUSTOM_ATTRIBUTE_1 ). VOLUME — значение по умолчанию.
• Тип измерения ( VOLUME ), указывающий, что ставка зависит от объема транзакций (то есть это не фиксированная ставка за транзакцию, как в случае модели взимания фиксированной ставки).
• Срок оплаты (например, 30 дней).
• Идентификатор вашей организации.
• «Базовая» или учетная валюта, которую использует ваша компания.
• Длительность и тип длительности, которые вместе определяют период времени, в течение которого агрегируется объем транзакций (или объем, связанный с настраиваемым атрибутом). Это также называется «базисом агрегирования». Объем транзакций агрегируется на основе агрегирования (например, за 1 месяц) для определения применимого диапазона объема.
• Счетчики агрегирования, которые используются для определения применимого диапазона объема.

Для каждого тарифа тарифного плана вы указываете:

• Тип тарифного плана ( RATECARD ).
• Ставка по плану. Например, если вы укажете 0,10, а валютой являются доллары США, с разработчика будет взиматься плата в размере 0,15 доллара США за каждую транзакцию (или, если на основе пользовательского атрибута, такого как количество байтов, переданных в транзакции, с разработчика будет взиматься плата в размере 0,15 доллара США за передачу заданное количество байт).
• Начальная и конечная единица полосы громкости. Начальная единица определяет нижний предел диапазона громкости, а конечная единица определяет верхний предел диапазона громкости. Например, если вы укажете начальную единицу 0 и конечную единицу 1000, диапазон объема будет охватывать до 1000 транзакций за период агрегации. Если валюта — доллары США, период агрегации — 1 месяц, а курс за первые 1000 транзакций — 0,15, то с разработчика взимается 0,15 доллара за транзакцию при сумме до 1000 транзакций в месяц.
  
  Подробную информацию о том, когда пакеты сбрасываются, см. в разделе «Когда взимаются периодические сборы и сбрасываются планы пакетов?».
  

  Если вы не укажете конечную единицу для конечного диапазона объема, ставка для этого диапазона будет применяться ко всем транзакциям после того, как количество транзакций превысит начальную единицу для этого диапазона. Например, если начальной единицей для последнего диапазона является 1000, и вы не указываете конечную единицу для этого диапазона, ставка для диапазона применяется ко всем транзакциям после 1000 транзакций в периоде агрегации.

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

Например, в следующем примере создается тарифный план с моделью взимания платы по объему. Ставка установлена ​​на уровне 0,15 доллара США за первые 1000 транзакций и 0,10 доллара США за все транзакции свыше 1000. Базис агрегации — 1 месяц. Оплата производится в течение 30 дней. (Детали прейскуранта выделены.)

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "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" \
-u email:password

Указание модели комплексной зарядки

В модели комплексной оплаты разработчик платит (авансом) за «пакет» транзакций (или за пакет на основе специального атрибута, такого как количество переданных байтов). Вы указываете тариф для каждого пакета и базу агрегации, то есть период времени, в течение которого разработчик может использовать пакет.

Например, предположим, что вы настроили два пакета, где размер первого пакета — от 1 до 1000 транзакций, а размер второго пакета — от 1001 до 2000 транзакций. Ставка составляет 50 долларов США за первый пакет и 40 долларов США за второй пакет, а базис агрегации равен 1. Если разработчик приобретает тарифный план для первого пакета, он платит 50 долларов США (аванс) за 1000 транзакций в месяц. С разработчика взимается установленная сумма независимо от того, полностью ли использован пакет. После окончания периода агрегации срок действия плана истекает. Если разработчик хочет снова использовать пакет, он должен снова приобрести план (и пакет).

То, что вы указываете в деталях тарифного плана, по существу совпадает с тем, что вы указываете в деталях тарифного плана для модели начисления в рамках объемного диапазона. Различия заключаются в следующем:

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

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

Например, в следующем примере создается тарифный план с моделью комплексной оплаты. Ставка установлена ​​в размере $50 за первый пакет (до 1000 транзакций) и $40 за второй пакет (более 1000 и до 2000 транзакций). Базис агрегирования – 1 месяц. Оплата производится в течение 30 дней.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "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" \
-u email:password

Указание бесплатного плана для отдельных продуктов с помощью API

В тарифном плане вы можете настроить бесплатный план для отдельного продукта (а не для пакета API). План Freemium предлагает разработчикам бесплатное использование продукта API в течение определенного периода времени или в зависимости от объема использования.

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

• Продолжительность, то есть время между датой вступления в силу и датой окончания.
• Количество, например количество транзакций с использованием продукта API или объем, относящийся к настраиваемому атрибуту, записанному в политике записи транзакций.

Если период бесплатной лицензии основан на количестве, укажите его как количество единиц бесплатной лицензии. Например, в следующем примере создается тарифный план с бесплатным планом на основе объема 5000 единиц (спецификации, связанные с бесплатным тарифом, выделены).

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "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" \
-u email:password