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

Метод Get List of Plans позволяет получить список всех Тарифных планов (см. также Получение списка Тарифных планов всех нижестоящих Реселлеров, Получение списка Тарифных планов Реселлера).

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

номер страницы (page).
количество элементов на странице (per_page).

Список тарифных планов может быть отсортирован по любому полю. Для сортировки списка Тарифных планов должны быть переданы следующие аргументы:

название поля для сортировки по нему (sorting[field]).
режим сортировки: по возрастанию или по убыванию (sorting[reversed]).

Список тарифных планов может быть отфильтрован по:

дате создания (filters[created_at]).
дате обновления (filters[updated_at]).
статусу (filters[status]).

флагу "опубликован" (filters[public]).

GET /api/vendor/v1/plans.json?api_token={api_token}

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)
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	Название Правила предоставления
billing_type	string	Тип биллинга Тарифного плана
ancestry	string	Для делегированных Тарифных планов содержит список ID родительских Тарифных планов, начиная от корневого (см. Просмотр списка делегированных тарифных планов)
plan_resources	array of objects	Информация о Ресурсах Тарифного плана
plan_resources.id	integer	ID Ресурса
plan_resources.name	string	Название Ресурса
plan_resources.application_template_name	string	Название Услуги, которая используется в рамках данного Тарифного плана
plan_resources.measurable	bool	Признак использования модели расчета стоимости за фактическое использование Ресурса (недоступен, если функция не поддерживается внешними службами): true — используется расчет за фактическое использование Ресурса. false — не используется расчет за фактическое использование Ресурса.
plan_resources.unit_of_measure	string	Единица измерения Ресурса: unit — измеряемый Ресурс, для которого указывается определенное количество. boolean — неизмеряемый Ресурс (для Ресурсов, у которых не надо указывать количество), возможные значения: true — Ресурс добавлен. false — Ресурс не добавлен.
plan_resources.included	integer	Количество Ресурса, которое будет включено в Тарифный план по умолчанию (включенные Ресурсы входят в стоимость Подписки)
plan_resources.minimum	integer	Минимальное количество Ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана в ActivePlatform. Руководство по Панели управления Оператора)
plan_resources.limit	integer	Максимальное количество Ресурса, доступное для заказа. Если Ресурс безлимитный (признак unlimited_units=true), то limit принимает значение 0. Limit может быть также равен 0 когда Ресурс не является безлимитным, если minimum и limit одновременно равны 0
plan_resources.setup_fee	float	Величина платежа за установку Ресурс
plan_resources.recurring_fee	float	Величина ежемесячной абонентской платы за Ресурс
plan_resources.overuse_fee	float	Стоимость перерасхода Ресурсов, включенных в Тарифный план
plan_resources.renewal_fee	float	Стоимость продления использования Ресурса
plan_resources.unlimited_units	bool	Признак отключения лимитов использования Ресурса: true — лимиты отключены. false — лимиты активны.
plan_resources.public	bool	Признак доступности Ресурса для продажи в рамках данного Тарифного плана: true — Ресурс доступен для заказа. false — Ресурс недоступен для заказа.
plan_resources.status	string	Статус Ресурса: active — активный. inactive — неактивный. deleted — удален.
plan_resources.resource_id	integer	ID Ресурса Тарифного плана
plan_resources.created_at	date	Дата и время создания Ресурса Тарифного плана
plan_resources.updated_at	date	Дата и время последнего изменения Ресурса Тарифного плана
plan_resources.custom_attributes	array of objects	Модель дополнительных атрибутов Ресурса
plan_resources.custom_attributes.['custom-attribute-key']	string	Значение дополнительного атрибута Ресурса
plan_periods	array of objects	Информация о периодах Тарифного плана
plan_periods.id	integer	ID периода Тарифного плана
plan_periods.duration_value	integer	Длительность периода Тарифного плана
plan_periods.duration_type	string	Единица измерения периода Тарифного плана
plan_periods.setup_fee	float	Стоимость установки Тарифного плана для данного периода
plan_periods.recurring_fee	float	Ежемесячная стоимость Тарифного плана для данного периода
plan_periods.renewal_fee	float	Стоимость обновления Тарифного плана для данного периода
plan_periods.trial	bool	Признак того, является ли период Тарифного плана пробным: true — период является пробным. false — период не является пробным.
plan_periods.public	bool	Признак доступности периода для заказа в рамках данного Тарифного плана: true — период доступен для заказа. false — период недоступен для заказа.
plan_periods.status	string	Статус периода Тарифного плана: active — активный. deleted — удален.
plan_periods.description	string	Описание периода Тарифного плана
plan_periods.created_at	date	Дата и время создания периода Тарифного плана
plan_periods.updated_at	date	Дата и время обновления периода Тарифного плана
attributes.custom-attributes	object	Модель дополнительных атрибутов Тарифного плана
attributes.custom-attributes.['custom-attribute-key']	string	Значение дополнительного атрибута Тарифного плана
plan_currency	string	Код валюты Тарифного плана

Пример запроса

https://test.activeplatform.com/api/vendor/v1/plans.json?api_token=Y5fwetest3gJXZH5uHCw&page=27&per_page=2

Пример ответа

[
    {
        "id": 149,
        "status": "inactive",
        "name": "wwww",
        "description": "",
        "created_at": "2016-12-09T16:39:40.015+03:00",
        "updated_at": "2019-11-22T14:13:51.171+03:00",
        "public": true,
        "product_category_id": 190,
        "product_category": "default",
        "product_id": 403,
        "product": "Default",
        "plan_class_id": 1,
        "plan_class": "default",
        "billing_type": "reservation",
        "ancestry": "",
        "plan_resources": [
            {
                "id": 1562,
                "name": "Ресурс4",
                "application_template_name": "Auto provisioning",
                "measurable": false,
                "unit_of_measure": "unit",
                "included": 0,
                "minimum": 0,
                "limit": 0,
                "setup_fee": "1.0",
                "recurring_fee": "15.0",
                "overuse_fee": "13.0",
                "renewal_fee": "14.0",
                "unlimited_units": false,
                "public": true,
                "status": "active",
                "resource_id": 272,
                "created_at": "2016-12-09T16:41:04.974+03:00",
                "updated_at": "2016-12-29T12:25:32.219+03:00",
                "custom_attributes": []
            }
        ],
        "plan_periods": [
            {
                "id": 513,
                "duration_value": 2,
                "duration_type": "month",
                "setup_fee": "1.0",
                "recurring_fee": "2.0",
                "renewal_fee": "4.0",
                "trial": false,
                "public": true,
                "status": "active",
                "description": null,
                "created_at": "2016-12-09T16:41:43.088+03:00",
                "updated_at": "2016-12-29T12:23:19.698+03:00"
            },
            {
                "id": 514,
                "duration_value": 3,
                "duration_type": "year",
                "setup_fee": "1.0",
                "recurring_fee": "557.0",
                "renewal_fee": "1.0",
                "trial": false,
                "public": true,
                "status": "active",
                "description": null,
                "created_at": "2016-12-09T16:41:43.108+03:00",
                "updated_at": "2016-12-29T12:23:19.876+03:00"
            }
        ],
        "custom_attributes": [],
        "plan_currency": "RUB"
    },
    {
        "id": 150,
        "status": "active",
        "name": "TrialTest",
        "description": "",
        "created_at": "2016-12-12T12:05:50.637+03:00",
        "updated_at": "2019-11-22T14:13:51.174+03:00",
        "public": true,
        "product_category_id": 190,
        "product_category": "default",
        "product_id": 403,
        "product": "Default",
        "plan_class_id": 5,
        "plan_class": "Domains, Licenses, SSL",
        "billing_type": "reservation",
        "ancestry": "",
        "plan_resources": [],
        "plan_periods": [
            {
                "id": 515,
                "duration_value": 3,
                "duration_type": "day",
                "setup_fee": "0.0",
                "recurring_fee": "0.0",
                "renewal_fee": "0.0",
                "trial": true,
                "public": true,
                "status": "active",
                "description": null,
                "created_at": "2016-12-12T12:06:29.453+03:00",
                "updated_at": "2016-12-12T12:06:29.453+03:00"
            }
        ],
        "custom_attributes": [],
        "plan_currency": "RUB"
    }
]