Получение Cписка тарифных планов

API-токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора):

• Если API-токен Сотрудника не указан, метод возвращает список только активных опубликованных Тарифных планов (status = active и public = true).
• Если API-токен Сотрудника указан, метод возвращает список всех Тарифных планов.

page

query

integer

Опциональный

Возвращается список Тарифных планов по указанному номеру страницы

per_page

query

integer

Опциональный

Установка числа элементов на странице

sorting[field]

query

string

Опциональный

Сортировка списка по указанному полю

sorting[reversed]

query

string

Опциональный

Установка режима обратной сортировки по указанному полю:

• true — список будет отсортирован по убыванию.
• false — список будет отсортирован по возрастанию (используется по умолчанию).

filters[created_at]

query

date

Опциональныйl

Фильтрация списка по дате создания

filters[updated_at]

query

date

Опциональный

Фильтрация списка по дате обновления

filters[status]

query

string

Опциональный

Фильтрация списка по статусу

filters[public]

query

string

Опциональный

Фильтрация списка по флагу "опубликован"

id

integer

ID Тарифного плана

status

string

Статус Тарифного плана: 

• active — Тарифный план доступен Клиентам.
• inactive — Тарифный план недоступен Клиентам, Тарифный план был деактивирован Менеджером (см. Деактивация тарифного плана).
• deactivated by provider — Тарифный план недоступен Клиентам, Тарифный план был деактивирован вышестоящим Реселлером (Оператором).

name

string

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

description

string

Дополнительная информация о Тарифном плане, которая отображается клиентам в Панели управления Клиента

created_at

data

Дата и время создания Тарифного плана

updated_at

data

Дата и время последнего изменения Тарифного плана

public

bool

Признак доступности Тарифного плана:

• true — Тарифный план доступен для заказа.
• false — Тарифный план недоступен для заказа.

product_category_id

integer

ID Категории продукта, с которым связан Тарифный план

product_category

string

Название Категории продукта, с которым связан Тарифный план

product_id

integer

ID Продукта, с которым связан Тарифный план

product

string

Название Продукта, с которым связан Тарифный план

plan_class_id

integer

ID Правила предоставления (см. Управление правилами предоставления тарифных планов в ActivePlatform. Руководство по Панели управления Оператора)

plan_class

string

Название Правила предоставления

ancestry

plan_resources

array of objects

Информация о Ресурсах Тарифного плана

Название Ресурса

Признак использования модели расчета стоимости за фактическое использование Ресурса (недоступен, если функция не поддерживается внешними службами):

• • true — используется расчет за фактическое использование Ресурса.
  • false — не используется расчет за фактическое использование Ресурса.

Единица измерения Ресурса:

• • unit — измеряемый Ресурс, для которого указывается определенное количество.
  • boolean — неизмеряемый Ресурс (для Ресурсов, у которых не надо указывать количество), возможные значения:
    • true — Ресурс добавлен.
    • false — Ресурс не добавлен.

Количество Ресурса, которое будет включено в Тарифный план по умолчанию (включенные Ресурсы входят в стоимость Подписки)

Минимальное количество Ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана в ActivePlatform. Руководство по Панели управления Оператора)

Максимальное количество Ресурса, доступное для заказа. Если Ресурс безлимитный (признак unlimited_units=true), то limit принимает значение 0. Limit может быть также равен 0 когда Ресурс не является безлимитным, если minimum и limit одновременно равны 0

Величина платежа за установку Ресурс

Величина ежемесячной абонентской платы за Ресурс

Стоимость перерасхода Ресурсов, включенных в Тарифный план

Стоимость продления использования Ресурса

Признак отключения лимитов использования Ресурса:

• true — лимиты отключены.
• false — лимиты активны.

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

• true — Ресурс доступен для заказа.
• false — Ресурс недоступен для заказа.

Статус Ресурса:

• active — активный.
• inactive — неактивный.
• deleted — удален.

ID Ресурса Тарифного плана

Признак того, является ли период Тарифного плана пробным:

• true — период является пробным.
• false — период не является пробным.

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

• true — период доступен для заказа.
• false — период недоступен для заказа.

Статус периода Тарифного плана:

• active — активный.
• deleted — удален.

Дата и время создания периода Тарифного плана

Дата и время обновления периода Тарифного плана

plan_currency