Получение информации о Тарифном плане

Метод Get Plan info by ID позволяет получить информацию о Тарифном плане, используя ID данного тарифного плана (см. также Получение списка тарифных планов всех нижестоящих реселлеров, Получение списка тарифных планов реселлера).

GET /api/reseller/v1/plans/{id}.json

Аргументы

Название

Тип параметра

Тип данных

Обязательный/
Опциональный

Описание

id

path

integer

Обязательный

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

api_token

query

string

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

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

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

Модель ответа

Название	Тип данных	Описание
id	integer	ID Тарифного плана.
status	string	Cтатус Тарифного плана: 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	array of objects	Модель дополнительных атрибутов Тарифного плана
attributes.custom-attributes.['custom-attribute-key']	string	Значение дополнительного атрибута Тарифного плана
plan_currency	string	Код валюты Тарифного плана

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

GET http://billing.activeplatform.com:80/api/reseller/v1/plans/1363.json?api_token=654321

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

{
    "id": 1363,
    "status": "inactive",
    "name": "Kaspersky Security для виртуальных сред, Desktop Russian Edition 15-19",
    "description": "Kaspersky Security для виртуальных сред, Desktop Russian Edition 15-19",
    "created_at": "2017-12-06T10:45:57.089+03:00",
    "updated_at": "2018-03-26T10:42:04.126+03:00",
    "public": false,
    "product_category_id": 551,
    "product_category": "default",
    "product_id": 495,
    "product": "Kaspersky Security",
    "plan_class_id": 10548,
    "plan_class": "Kaspersky",
    "billing_type": "pay_in_full",
    "ancestry": "",
    "plan_resources": [
        {
            "id": 6099,
            "name": "Quantity",
            "application_template_name": "Kaspersky Security",
            "measurable": null,
            "unit_of_measure": "unit",
            "included": 15,
            "minimum": 15,
            "limit": 19,
            "setup_fee": 0,
            "recurring_fee": 170.32,
            "overuse_fee": 0,
            "renewal_fee": 0,
            "unlimited_units": false,
            "public": true,
            "status": "active",
            "resource_id": 2018,
            "created_at": "2017-12-06T10:45:57.115+03:00",
            "updated_at": "2017-12-06T11:56:01.830+03:00",
            "custom_attributes": []
        }
    ],
    "plan_periods": [
        {
            "id": 3055,
            "duration_value": 1,
            "duration_type": "month",
            "setup_fee": 0,
            "recurring_fee": 170.32,
            "renewal_fee": 0,
            "trial": false,
            "public": true,
            "status": "active",
            "description": null,
            "created_at": "2017-12-06T10:45:57.149+03:00",
            "updated_at": "2017-12-27T16:27:00.740+03:00"
        },
        {
            "id": 3054,
            "duration_value": 3,
            "duration_type": "month",
            "setup_fee": 0,
            "recurring_fee": 510,
            "renewal_fee": 0,
            "trial": false,
            "public": true,
            "status": "active",
            "description": null,
            "created_at": "2017-12-06T10:45:57.133+03:00",
            "updated_at": "2017-12-27T16:27:00.725+03:00"
        }
    ],
    "custom_attributes": [],
    "plan_currency": "RUB"
}