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

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

Введение

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

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

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

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

Если в плане есть... ...это случается
  • Ненулевой периодический сбор, установленный на месяц.
  • План Volume Banded или Bundle

Регулярная плата и сброс тарифного плана происходят первого числа месяца (по умолчанию).

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

  • Ненулевой периодический сбор, установленный на неделю.
  • План Volume Banded или Bundle
 Регулярная плата и сброс тарифного плана происходят каждые 7 дней после даты начала действия тарифного плана разработчика.
  • Ненулевая регулярная плата, установленная на день.
  • План Volume Banded или Bundle
 Регулярная плата и сброс пакетного плана происходят каждые X дней после даты начала действия тарифного плана разработчика.
  • Нет (или нулевой доллар) регулярной комиссии
  • План Volume Banded или Bundle

Пакетные планы сбрасываются на основе основы агрегирования, определенной в прейскуранте. Например, если застройщик запускает тарифный план 19 числа месяца, а Базис агрегации — каждый 1 месяц, то использование пакета обнуляется каждый месяц 19 числа.

Обратите внимание, что день месяца может не всегда совпадать. Например, если тарифный план начинается 31 декабря, датой сброса становится 28-е число февраля невисокосного года, поскольку в феврале всего 28 дней. 28-е число всегда остается днем ​​сброса.

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

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

Край

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

Модель зарядки Описание
Единая ставка Разработчик взимает фиксированную ставку за каждую транзакцию.
Объемный полосатый Разработчик взимает переменную ставку в зависимости от объема транзакций.
Пакеты Разработчик взимает фиксированную сумму аванса за каждый пакет транзакций. С разработчика взимается установленная сумма независимо от того, используется пакет целиком или нет.

Примечание . Этот параметр недоступен, если вы выбираете Прейскурант и Доля дохода.

Затем настройте следующую информацию в зависимости от выбранной модели зарядки.

Модель зарядки Поле Описание
Все Частота расчета Период времени, за который рассчитывается объем транзакций (или объем, связанный с пользовательским атрибутом). Выберите количество месяцев (1–24 месяца).
Единая ставка Единая ставка Ставка взимается за каждую транзакцию. Введите десятичное число (до четырех знаков после запятой).

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

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

Объемный полосатый Полосы громкости Один или несколько диапазонов объема транзакций (или на основе атрибутов клиента) (каждый диапазон представляет собой «диапазон объема») для модели начисления платы в зависимости от объема. Каждой полосе громкости можно назначить скорость. Ставка применяется ко всем транзакциям в соответствующем диапазоне объема. Укажите верхнюю границу первого диапазона, например, до 1000 (нижняя граница задана больше 0).

Нажмите +Создать , чтобы добавить дополнительные группы.

Оставьте верхнюю границу финального диапазона пустой, чтобы указать все транзакции выше этого уровня.

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

Например, если вы указываете два диапазона громкости в разделе «Диапазон громкости» (>0–1000 и 1000 и выше), вы можете ввести 0,15 для диапазона громкости >0–1000 и 0,10 для диапазона громкости 1000 и выше. Если выбранная валюта — доллары США, курс для первых 1000 транзакций составляет 0,15 доллара США за каждую транзакцию, а для более 1000 транзакций — 0,10 доллара США за каждую транзакцию.

Пакеты Цены на пакеты API Количество транзакций в пакете (или число, связанное с настраиваемым атрибутом, например общее количество байтов, переданных в пакете). Каждому пакету можно назначить цену. Цена распространяется на весь комплект. Укажите верхний предел первого пакета, например до 1000 (нижний предел задан больше 0).

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

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

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

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

В этом случае выберите « Использовать настраиваемый параметр рейтинга» и выберите настраиваемый атрибут из раскрывающегося списка. Дополнительную информацию см. в разделе Настройка тарифного плана с настраиваемыми атрибутами .

Классический Edge (частное облако)

Чтобы настроить тарифные планы с помощью классического пользовательского интерфейса Edge:

  1. Следуйте инструкциям, чтобы создать тарифный план .
  2. Выберите «Тариф» в раскрывающемся списке «Тип тарифного плана», чтобы настроить модель дохода .
  3. Если выбранный пакет API включает несколько продуктов API, выберите один из следующих вариантов:

    Примечание . Если пакет API включает один продукт API, вы можете пропустить этот шаг.

    • Планы для конкретного продукта , позволяющие настроить детали тарифного плана для каждого продукта API индивидуально.
    • Общий план для всех продуктов , позволяющий настроить детали тарифного плана для всех продуктов API.
  4. Нажмите «Тариф», чтобы выбрать общий тарифный план или тарифный план для каждого отдельного продукта API.

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

    Откроется окно Прейскурант.

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

    Введите следующую информацию:

    Поле Описание
    Фримиум-продукт?

    Продолжительность бесплатного периода. Выберите один из следующих переключателей:

    • По количеству. Бесплатный период зависит от количества, указанного в поле «Объем».
    • По продолжительности. Период оплаты основан на временном интервале, указанном в поле «Продолжительность бесплатной подписки».
    • Что наступит раньше. Бесплатный период заканчивается, когда достигается количество, указанное в поле «Объем», или временной интервал, указанный в поле «Продолжительность бесплатной подписки», в зависимости от того, что произойдет раньше.
    • Нет. Это не план Freemium. Это значение по умолчанию.
    Фримиум-объем

    Объем транзакций (или объем, относящийся к настраиваемому атрибуту, записанному в политике записи транзакций), за который разработчики не взимают плату. Объем измеряется для продукта API. Введите номер тома, например 5000. Это означает, что когда разработчики запускают план, с них не взимается плата за первые 5000 транзакций (или за первые 5000 использований элемента, связанного с настраиваемым атрибутом). Это поле становится доступным только в том случае, если вы выбрали «По количеству» или «Что наступит раньше» в разделе «Бесплатный продукт?» поле.

    Продолжительность бесплатного режима

    Интервал времени, в течение которого с разработчиков не взимается плата. Введите число и выберите период времени, например, 1 месяц. Это означает, что с разработчиков не взимается плата за 1 месяц. Это поле становится доступным только в том случае, если вы выбрали «По продолжительности» или «Что наступит раньше» в «Продукте условно-бесплатной версии?» поле.

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

    Для модели с фиксированной ставкой: введите следующую информацию в раздел «Цены» окна «Общий тариф»:

    Поле Описание
    Оператор (или организация)

    Название вашей организации. Это поле предварительно задается с использованием значения поля Оператор (или Организация) в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается с использованием значения поля Страна в профиле организации.

    Единая ставка

    Ставка, взимаемая за каждую транзакцию. Введите десятичное число (до четырех знаков после запятой).

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

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

    Для модели с диапазоном объема: в окне «Общая тарифная карта» отображаются дополнительные поля, которые вы используете для указания основы для агрегирования и указания «диапазонов объема», то есть диапазонов объема транзакции, к которым можно применять разные ставки.

    Этот тип плана обычно создается для того, чтобы побудить разработчиков генерировать более высокие объемы, предлагая скидки для более высоких объемов.

    Введите следующую информацию в окне «Общий тариф»:

    Поле Описание
    Основа агрегирования

    Период времени, за который суммируется объем транзакций (или объем, связанный с пользовательским атрибутом). Агрегированный объем используется для определения диапазона объема и ставки, применяемой к каждой транзакции. Выберите количество месяцев (1-12 месяцев).

    Подробную информацию о том, когда пакеты сбрасываются, см. в разделе «Когда взимаются периодические сборы и сбрасываются планы пакетов?».

    Полосы громкости

    Один или несколько диапазонов объема транзакций (или на основе атрибутов клиента) (каждый диапазон представляет собой «диапазон объема»). Каждому диапазону объема может быть назначена ставка (эта ставка задается в поле «Диапазоны объема» раздела «Цены»). Ставка применяется ко всем транзакциям в соответствующем диапазоне объема. Укажите верхнюю границу первого диапазона, например, до 1000 (нижняя граница задана больше 0). Нажмите +, чтобы добавить второй диапазон, например от 1000 до 2000. Нажмите +, чтобы добавить больше диапазонов. Вы можете оставить верхнюю границу итогового диапазона пустой, чтобы указать все транзакции выше этого уровня.

    Цены
    Оператор (или организация)

    Название вашей организации. Это поле предварительно задается с использованием значения поля «Оператор» (или «Организация») в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается с использованием значения поля «Страна» в профиле организации.

    Валюта

    «Базовая» или учетная валюта, которую использует ваша организация. Это поле предварительно задано с использованием значения поля «Валюта» в профиле организации, но его можно изменить здесь.

    Полосы громкости

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

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

    Например, если вы указываете два диапазона громкости в разделе «Диапазон громкости» (>0–1000 и 1000 и выше), вы можете ввести 0,15 для диапазона громкости >0–1000 и 0,10 для диапазона громкости 1000 и выше. Если выбранная валюта — доллары США, курс для первых 1000 транзакций составляет 0,15 доллара США за каждую транзакцию, а для более 1000 транзакций — 0,10 доллара США за каждую транзакцию.

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

    Введите следующую информацию в окне «Общий тариф»:

    Поле Описание
    Основа агрегирования

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

    Подробную информацию о том, когда пакеты сбрасываются, см. в разделе «Когда взимаются периодические сборы и сбрасываются планы пакетов?».

    Размер комплекта

    Количество транзакций в пакете (или число, связанное с настраиваемым атрибутом, например общее количество байтов, переданных в пакете). Каждому пакету можно назначить цену (эту цену вы устанавливаете в поле «Размер пакета» раздела «Цены»). Цена применяется ко всему пакету. Укажите верхний предел первого пакета, например до 1000 (нижний предел задан больше 0). Нажмите +, чтобы добавить второй пакет, например от 1000 до 2000. Нажмите +, чтобы добавить больше пакетов. Вы должны указать верхний предел для последнего пакета, если только вы не хотите взимать с разработчика фиксированную сумму за неограниченное количество транзакций в последнем пакете.

    Цены
    Оператор (или организация)

    Название вашей организации. Это поле предварительно задается с использованием значения поля «Оператор» (или «Организация») в профиле организации.

    Страна

    Страна деятельности вашей организации. Это поле предварительно задается с использованием значения поля «Страна» в профиле организации.

    Валюта

    «Базовая» или учетная валюта, которую использует ваша организация. Это поле предварительно задается с использованием значения поля «Валюта» в профиле организации, но его можно изменить здесь.

    Размер комплекта (цена)

    Цена за комплект. Вы указываете цену за каждый комплект. Введите десятичное число (до четырех знаков после запятой).

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

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

  7. Нажмите «Применить» и «Закрыть» , чтобы сохранить данные прейскуранта и вернуться в окно «Стандартный тарифный план».
  8. Для тарифных планов для конкретных продуктов 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