Как настроить план с тарифами

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

Введение

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

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

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

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

Если в тарифном плане есть… ...происходит следующее:
  • Ненулевая регулярная комиссия, установленная на месяц.
  • Тарифный план с пакетом или диапазоном трафика

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

Чтобы создать тарифный план с ежемесячным повторением в определенный день, используйте API управления и укажите день с помощью свойства RecurringStartUnit, как описано в разделе Создание тарифных планов с помощью API.
  • Ненулевая регулярная комиссия, установленная на неделю.
  • Тарифный план с пакетом или диапазоном трафика
 Списание регулярной комиссии и сброс тарифного плана происходят каждые 7 дней после даты начала действия тарифа разработчика.
  • Ненулевая регулярная комиссия, установленная на день.
  • Тарифный план с пакетом или диапазоном трафика
 Списание регулярного платежа и сброс тарифного плана происходят каждые X дней после даты начала действия тарифного плана разработчика.
  • Отсутствие регулярной комиссии или ее нулевой размер.
  • Тарифный план с пакетом или диапазоном трафика

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

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

Как настроить планы на основе цен с помощью интерфейса

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

Edge

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

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

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

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

Модель зарядки Поле Описание
Все Частота расчета Период времени, за который рассчитывается объем транзакций (или объем, связанный со специальным атрибутом). Выберите количество месяцев (от 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 долл. США за транзакцию, а за последующие – 0,10 долл. США за транзакцию.

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

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

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

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

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

В этом случае выберите Использовать специальный параметр рейтинга и выберите настраиваемый атрибут из списка. Подробнее о том, как настроить тарифный план с помощью специальных атрибутов…

Классическая версия Edge (частное облако)

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

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

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

    • Планы для отдельных продуктов, чтобы настроить сведения о тарифных планах для каждого продукта API.
    • Generic Plan for All Products, чтобы настроить тарифный план для всех продуктов API.
  4. Нажмите Тарифы для общего тарифного плана или для каждого тарифного плана, относящегося к определенному продукту API.

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

    Откроется окно "Тариф".

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

    Заполните следующие поля:

    Поле Описание
    Товар с ограниченным бесплатным доступом?

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

    • По количеству. Бесплатный период определяется количеством, указанным в поле "Том".
    • По продолжительности. Платный период определяется интервалом времени, указанным в поле "Продолжительность бесплатного периода".
    • в зависимости от того, что наступит раньше. Бесплатный период заканчивается, когда достигается количество, указанное в поле "Количество", или истекает временной интервал, указанный в поле "Продолжительность бесплатного периода", в зависимости от того, что произойдет раньше.
    • Нет, это не бесплатный план. Это значение используется по умолчанию.
    Freemium Volume

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

    Период времени, в течение которого с разработчиков не взимается комиссия. Введите число и выберите период времени, например "1 месяц". Это означает, что в течение месяца с разработчиков не взимается плата. Это поле доступно, только если в поле "Товар Freemium?" выбран вариант "По продолжительности" или "По истечении срока или продолжительности".
  6. Выберите одну из следующих моделей оплаты:
    • Единая ставка. В этой модели разработчик платит фиксированную комиссию за каждую транзакцию.
    • Со шнурком. В этой модели комиссия взимается по переменной ставке в зависимости от количества транзакций.
    • Наборы. В этой модели разработчик платит фиксированную сумму (авансом) за каждый пакет транзакций. Разработчик платит установленную сумму независимо от того, был ли использован весь пакет.

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

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

    Название организации. Это поле заполняется автоматически на основе значения поля "Оператор (или организация)" в профиле организации.
    Страна

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

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

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

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

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

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

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

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

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

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

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

    Название организации. Это поле заполняется автоматически на основе значения поля "Оператор" (или "Организация") в профиле организации.
    Страна

    Страна, в которой работает ваша организация. Это поле заполняется автоматически на основе значения поля "Страна" в профиле организации.
    Валюта

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

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

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

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

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

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

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

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

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

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

    Название организации. Это поле заполняется автоматически на основе значения поля "Оператор" (или "Организация") в профиле организации.
    Страна

    Страна, в которой работает ваша организация. Это поле заполняется автоматически на основе значения поля "Страна" в профиле организации.
    Валюта

    Базовая валюта, которую использует ваша организация. Это поле заполняется автоматически на основе значения поля "Валюта" в профиле организации, но его можно изменить.
    Размер набора (цена)

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

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

    Например, если в разделе "Размер пакета" вы указали два пакета (больше 0 до 1000 и больше 1000 до 2000), то для первого пакета можно ввести значение 50, а для второго – 40. Если выбрана валюта "Доллары США", то цена первого пакета составит 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 дней).
  • Идентификатор организации.
  • Базовая валюта, используемая вашей компанией для ведения бухгалтерского учета.
  • Продолжительность и тип продолжительности, которые вместе определяют период времени, в течение которого агрегируется объем транзакций (или объем, связанный со специальным атрибутом). Это также называется "основой агрегирования". Количество транзакций агрегируется на основе выбранного периода (например, одного месяца), чтобы определить подходящий диапазон.
  • Счетчики агрегирования, которые используются для определения подходящего диапазона объема.

Для каждого тарифа необходимо указать:

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

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

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

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

Например, следующий код создает тарифный план с моделью ценообразования на основе объема. Для первых 1000 транзакций комиссия составляет 0,15 долл.США, а для всех остальных – 0,10 долл.США. Агрегирование выполняется за месяц. Оплата должна быть произведена в течение 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 транзакций в месяц. Разработчик платит установленную сумму независимо от того, был ли использован весь пакет. После окончания периода агрегирования план перестает действовать. Если разработчик захочет снова воспользоваться набором, ему придется приобрести тарифный план (и набор) ещё раз.

Информация, которую вы указываете в сведениях о тарифном плане, по сути, такая же, как и в сведениях о тарифном плане для модели ценообразования с учетом объема. Их отличия описаны ниже.

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

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

Например, следующий код создает тарифный план с моделью оплаты в составе пакета. Первый пакет (до 1000 транзакций) стоит 50 долларов США, а второй (от 1001 до 2000 транзакций) – 40 долларов США. Агрегирование выполняется за месяц. Срок оплаты – 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

Как указать тарифный план Freemium для отдельных товаров с помощью API

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

При настройке плана Freemium для продукта 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