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

Метод Get the Reseller's Plan by ID используется для получения информации о Тарифном плане Реселлера по указанному ID Тарифного плана для текущего Реселлера или любого из его нижестоящих Реселлеров.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)
plan_idpathintegerОбязательный

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

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

Название

Тип данных

Описание

dataarrayДанные ответа


id

integer

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


typestringТип данных

attributesobjectИнформация о Тарифном плане


created_at

date

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



updated_at

date

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



statusstringСтатус Тарифного плана (список статусов см. в Просмотр списка тарифных планов)


name

string

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



description

string

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



public

bool

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

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


plan_class_id

integer

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



product_id

integer

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



billing_typestringТип биллинга Тарифного плана


ancestrystringДля делегированных Тарифных планов содержит список ID родительских Тарифных планов, начиная от корневого (см. Просмотр списка делегированных тарифных планов). Для Тарифных планов, созданных Сотрудником выбранного Реселлера, равен null


reseller_idintegerID Реселлера, которому принадлежит Тарифный план


fixed_pricebool

Признак Фиксированная цена Тарифного плана:

  • true — Клиент получает возможность оплачивать Подписку и заказывать дополнительные Ресурсы по фиксированной цене, которая была установлена в Тарифном плане на момент заказа Подписки. Новая стоимость будет применена к Подписке только после ее продления.
  • false — цены Тарифного плана не фиксируются.


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


singletonbool

Признак Единичный Тарифного плана:

  • true — Клиент может иметь только одну Подписку на этот Тарифный план.
  • false — Клиент может иметь неограниченное количество Подписок на этот Тарифный план.


auto_renewalbool

Состояние опции Автопродление по умолчанию для Подписок на этот Тарифный план:

  • true — опция Автопродление включена.
  • false — опция Автопродление выключена.


auto_renewal_disabledbool

Состояние опции Блокировать опцию Автопродление по умолчанию для Подписок на этот Тарифный план:

  • true — опция Блокировать опцию Автопродление включена.
  • false — опция Блокировать опцию Автопродление выключена.


plan_class

string

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



product_category_id

integer

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



product_category

string

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



product

string

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



plan_resources

array of objects

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




dataarrayДанные объекта




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




typestringТип данных




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





created_atdateДата и время создания Ресурса





updated_atdateДата и время последнего обновления Ресурса





namestring

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






measurablebool

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

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





unit_of_measurestring

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

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





application_template_namestringНазвание Услуги, которая предоставляется в рамках данного Тарифного плана





includedinteger

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






minimuminteger

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






limitinteger

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






setup_feefloat

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






recurring_feefloat

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






overuse_feefloat

Стоимость перерасхода Ресурсов






renewal_feefloat

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






unlimited_unitsbool

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

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





publicbool

Возможные значения:

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





statusstring

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

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





resource_idinteger

ID Ресурса в Шаблоне услуги






priorityintegerПриоритет Ресурса. У основного Ресурса priority максимальный





net_costsobject
  • Для делегированных Тарифных планов (см. значение ancestry) — значения стоимостей указанных типов, заданные для Ресурса Тарифного плана на уровне вышестоящего Реселлера (себестоимость Ресурса Тарифного плана).
  • Для остальных Тарифных планов все значения стоимостей равны 0.






setup_feefloat

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







recurring_feefloat

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







overuse_feefloat

Стоимость перерасхода Ресурсов







renewal_feefloat

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






custom_attributesobjectИнформация о Дополнительных параметрах Ресурса в виде пар "ключ-значение"






plan_resources.custom_attributes.['custom-attribute-key']stringЗначение Дополнительного параметра Ресурса


plan_periodsarray of objectsИнформация о периодах Тарифного плана



data
arrayДанные объекта




idintegerID периода Тарифного плана




typestringТип данных




attributesobjectИнформация о периодах Тарифного плана





created_atdate

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






updated_atdate

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






duration_valueintegerДлительность периода Тарифного плана. Если период бессрочный, то duration_value = null





duration_typestringЕдиница измерения периода Тарифного плана. Если период бессрочный, то duration_type = null





setup_feefloatСтоимость установки Тарифного плана для данного периода





recurring_feefloatЕжемесячная стоимость Тарифного плана для данного периода





transfer_feefloatСтоимость переноса Домена, если Услуги включает в себя возможность использования Доменов





renewal_feefloatСтоимость продления Тарифного плана для данного периода





trialbool

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

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





publicbool

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

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





statusstring

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

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





descriptionstringОписание периода Тарифного плана





endlessbool

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

  • true — период является бессрочным.
  • false — период не является бессрочным. Продолжительность периода указана в duration_value и duration_type.





net_costsobject
  • Для делегированных Тарифных планов (см. значение ancestry) — значения стоимостей указанных типов, заданные для периода Тарифного плана на уровне вышестоящего Реселлера (себестоимость периода Тарифного плана).
  • Для остальных Тарифных планов все значения стоимостей равны 0.






setup_feefloatСтоимость установки Тарифного плана для данного периода






recurring_feefloatЕжемесячная стоимость Тарифного плана для данного периода






transfer_feefloatСтоимость переноса Домена, если Услуга включает в себя возможность использования Доменов






renewal_feefloatСтоимость продления Тарифного плана для данного периода


available_account_types

array of objectsИнформация о Типах клиентов



id

integer

ID Типа клиента



namestringИмя Типа клиента



created_at

date

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



updated_at

date

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



reseller_idintegerID Реселлера, к которому относится Тип клиента



name_patternstringШаблон отображения имени Клиента в платформе



primary_namestringНазвание поля с основным именем Клиента. Например, для Типа клиента Юридическое лицо это может быть Название компании



keystringКлюч Типа клиентов



default_payment_method_idinteger

ID способа оплаты (см. Способы оплаты), который используется по умолчанию для данного Типа клиентов




ancestryintegerID родительского Типа клиентов



use_by_default

bool

Признак Типа клиента по умолчанию:

  • true — Типа клиента используется по умолчанию.
  • false — Типа клиента не используется по умолчанию.


plan_currency

stringКод валюты Тарифного плана


custom-attributesobjectИнформация о Дополнительных параметрах Тарифного плана



custom-attributes.['custom-attribute-key']stringЗначение Дополнительного параметра Тарифного плана

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

GET /api/v3/resellers/1/plans/368
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "368",
        "type": "plans",
        "attributes": {
            "created_at": "2017-07-07T11:28:07.244+03:00",
            "updated_at": "2017-07-07T11:28:07.404+03:00",
            "status": "active",
            "name": "Plan VSP billing info 7/1",
            "description": "The best Plan",
            "public": true,
            "plan_class_id": 1366,
            "product_id": 403,
            "billing_type": "reservation",
            "ancestry": null,
            "reseller_id": 1,
            "fixed_price": true,
            "sku": "f54f74e9a239",
            "singleton": false,
            "auto_renewal": true,
            "auto_renewal_disabled": false,
            "plan_class": "Plan VSP billing info 7-Reservation",
            "product_category_id": 190,
            "product_category": "default",
            "product": "Default",
            "plan_resources": {
                "data": [
                    {
                        "id": "2005",
                        "type": "plan_resources",
                        "attributes": {
                            "created_at": "2017-07-07T11:28:07.320+03:00",
                            "updated_at": "2017-07-07T11:28:07.320+03:00",
                            "name": "Users",
                            "measurable": null,
                            "unit_of_measure": "unit",
                            "application_template_name": "Plan VSP billing info 7",
                            "included": 1,
                            "minimum": 1,
                            "limit": 300,
                            "setup_fee": "0.0",
                            "recurring_fee": "249.93",
                            "overuse_fee": "0.0",
                            "renewal_fee": "0.0",
                            "unlimited_units": false,
                            "public": true,
                            "status": "active",
                            "resource_id": 997,
                            "priority": 0,
                            "net_costs": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0"
                            },
                            "custom_attributes": {}
                        }
                    },
                    {
                        "id": "2006",
                        "type": "plan_resources",
                        "attributes": {
                            "created_at": "2017-07-07T11:28:07.349+03:00",
                            "updated_at": "2017-07-07T11:28:07.349+03:00",
                            "name": "Лицензии",
                            "measurable": null,
                            "unit_of_measure": "unit",
                            "application_template_name": "Plan VSP billing info 7",
                            "included": 0,
                            "minimum": 0,
                            "limit": 300,
                            "setup_fee": "0.0",
                            "recurring_fee": "249.93",
                            "overuse_fee": "0.0",
                            "renewal_fee": "0.0",
                            "unlimited_units": false,
                            "public": true,
                            "status": "active",
                            "resource_id": 998,
                            "priority": 1,
                            "net_costs": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0"
                            },
                            "custom_attributes": {}
                        }
                    }
                ]
            },
            "plan_periods": {
                "data": [
                    {
                        "id": "819",
                        "type": "plan_periods",
                        "attributes": {
                            "created_at": "2017-07-07T11:28:07.366+03:00",
                            "updated_at": "2017-07-07T11:28:07.366+03:00",
                            "duration_value": 1,
                            "duration_type": "year",
                            "setup_fee": "4.0",
                            "recurring_fee": "4.0",
                            "transfer_fee": "0.4",
                            "renewal_fee": "5.54",
                            "trial": false,
                            "public": true,
                            "status": "active",
                            "description": null,
                            "endless": false,
                            "net_costs": {
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0"
                            }
                        }
                    }
                ]
            },
            "available_account_types": [
                {
                    "id": 1,
                    "name": "Personal BLR",
                    "created_at": "2016-08-25T09:26:12.658+03:00",
                    "updated_at": "2019-05-08T07:21:42.843+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personalblr",
                    "default_payment_method_id": 2,
                    "ancestry": null,
                    "use_by_default": false
                },
                {
                    "id": 2,
                    "name": "Business BLR",
                    "created_at": "2016-08-25T09:26:12.674+03:00",
                    "updated_at": "2019-05-08T03:11:31.082+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%primary_name",
                    "primary_name": "Company name",
                    "key": "businessblr",
                    "default_payment_method_id": 197,
                    "ancestry": null,
                    "use_by_default": false
                }
            ],
            "plan_currency": "RUB",
            "custom_attributes": {
                "item_1c_id": "123456"
            }
        }
    }
}