Как создавать тарифные планы на будущее

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

Введение

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

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

Если для текущего тарифного плана не задана дата окончания, вы можете заменить его будущим тарифным планом, который начнет действовать уже сегодня. Вам нужно будет закрыть текущий тарифный план, как описано в разделе Как закрыть опубликованный тарифный план.

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

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

Как создать тарифный план на будущее с помощью интерфейса

Создайте тарифный план на будущее, как описано ниже.

Edge

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

  1. На странице тарифных планов наведите курсор на строку, связанную с тарифным планом, для которого вы хотите создать будущий тарифный план.
    У тарифного плана должна быть дата окончания.
  2. Нажмите + Будущее.
  3. В разделе Будущий тарифный план выберите один из следующих вариантов:
    • Начать новый период действия контракта с новой даты вступления в силу. Будущий тарифный план начнет действовать с даты вступления в силу. Срок продления будущего тарифного плана такой же, как у текущего.
    • Вычесть время, затраченное на предыдущий контракт, из нового периода в дату вступления в силу. Будущий тарифный план вступит в силу в дату вступления в силу. Время, в течение которого вы пользовались текущим тарифным планом, будет вычтено из срока действия нового тарифного плана. Это означает, что если разработчик использует текущий план в течение трех месяцев, то срок продления будет сокращен на три месяца.
  4. На верхней панели настройте следующие поля:
    Примечание. Остальные поля доступны только для чтения.
    Поле Описание По умолчанию Обязательно
    Название тарифного плана

    Название тарифного плана.

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

    Название существующего плана Да
    Дата начала Дата вступления в силу тарифного плана. Введите дату начала или выберите ее в календаре. Сегодня Нет
    Дата окончания Дата окончания тарифного плана. Чтобы указать дату окончания, включите переключатель Дата окончания и введите дату или выберите ее в календаре.

    Примечание. Тарифный план будет действовать до конца дня указанной даты. Если вы хотите, чтобы тарифный план перестал действовать 1 декабря 2018 г., укажите в качестве значения endDate 2018-11-30. В этом случае тарифный план перестанет действовать в конце дня 30 ноября 2018 г., и все запросы 1 декабря 2018 г. будут заблокированы.

    Нет Нет
    Видимость для порталов Укажите, является ли тарифный план общедоступным или частным. Подробнее о различиях между открытыми и закрытыми тарифными планами… Включено Нет
  5. Настройте комиссии для тарифного плана. Подробнее о настройке комиссий…
    Примечание. Неприменимо к планам с настраиваемыми уведомлениями.
  6. Если вы выбрали пакет продуктов, в который входит несколько продуктов API, задайте следующие параметры в разделе Особый или общий тарифный план:
    Примечание. Этот шаг неприменим к тарифным планам с регулируемыми уведомлениями.
    Поле Описание По умолчанию
    Настройте каждый продукт отдельно. Флаг, указывающий, нужно ли настраивать отдельный тарифный план для каждого продукта API. Отключено
    Как настроить бесплатное предложение для каждого товара Флаг, указывающий, нужно ли настраивать бесплатный тарифный план для каждого продукта API. Отключено
    Выберите товар Если вы включите один или оба флага, вам нужно будет выбрать каждый товар по отдельности из раскрывающегося списка и настроить тарифный план.

    Примечание. Убедитесь, что вы настроили все товары в наборе.

    Н/Д
  7. Настройте тарифный план в зависимости от его типа:
  8. Нажмите на один из следующих вариантов:
    Кнопка Описание
    Обновить черновик Сохраните тарифный план как черновик.

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

    Опубликовать черновик Опубликуйте план.

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

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

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

  1. В каталоге пакетов нажмите +Будущее в столбце "Черновик/Будущее" для тарифного плана, который нужно заменить.

    Откроется окно с будущим тарифным планом.

    Основное отличие между окном будущего тарифного плана и окном текущего тарифного плана – это раздел "Существующие подписчики".

  2. Как и для любого другого тарифного плана:
    • Введите название плана в поле "Название тарифного плана". Название может не совпадать с названием исходного тарифного плана.
    • Настройка сборов для тарифного плана (необязательно).
    • Настройте тарифный план в зависимости от его типа:
    • Укажите дату начала действия будущего тарифного плана (см. Как опубликовать тарифные планы) и дату окончания (если вы не хотите, чтобы будущий тарифный план действовал до определенной даты, выберите "Нет даты окончания"). Если для текущего плана задана дата окончания, то дата вступления в силу будущего плана должна быть позже даты окончания текущего плана.
  3. В разделе "Существующие подписчики" выберите один из следующих вариантов:
    • Начать новый период действия договора с новой даты вступления в силу. Новый тарифный план начнет действовать с указанной даты. Срок продления будущего тарифного плана такой же, как у текущего.
    • Вычесть время, затраченное на предыдущий контракт, из нового периода в дату вступления в силу. Новый тарифный план начнет действовать в указанную дату. Время, в течение которого вы пользовались текущим тарифным планом, будет вычтено из срока действия нового тарифного плана. Это означает, что если разработчик использует текущий план в течение трех месяцев, то срок продления будет сокращен на три месяца.
  4. В поле "Дата начала действия" укажите дату, которая наступает после даты окончания действия существующего тарифного плана.

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

Чтобы создать тарифный план с будущей датой начала с помощью API, отправьте запрос POST на адрес /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}/revision.

Где:

  • {org_id} – название организации.
  • {package_id} – идентификатор пакета API.
  • {plan_Id} – идентификатор тарифного плана.
При создании версии в теле запроса необходимо указать следующие свойства:
  • parentRatePlan – идентификатор исходного тарифного плана.
  • startDate – дата, с которой начнет действовать новый план.

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

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

Например, следующий запрос создает тарифный план на будущее:

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "parentRatePlan": {
       "id": "monetization_package_flat_rate_card_plan_1379513833409"
     },
     "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": "myorg"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.05",
        "startUnit": "0"       
       }      
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2014-01-01 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/monetization_package_flat_rate_card_plan_1379513833409/revision" \
-u email:password