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

Метод Get list of plans используется для получения cписка тарифных планов текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

page[size]

query

integer

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

Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number]

query

integer

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

Параметр постраничной навигации. Номер страницы ответа

filter[name]

query

integer

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

Предназначен для фильтрации списка тарифных планов по названию name — по частичному совпадению и без учета регистра
filter[sku]

query

integer

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

Предназначен для фильтрации списка тарифных планов по SKU sku — по частичному совпадению и без учета регистра
filter[updated_at]

query

string

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

Предназначен для фильтрации тарифных планов по дате дате и времени последнего обновления в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[updated_at][gt] — дата и время более, чем указанные.
  • filter[updated_at][gte] — дата и время больше или равны указанным.
  • filter[updated_at][lt] — дата и время менее, чем указанные.
  • filter[updated_at][lte] — дата и время меньше или равны указанным.
includequerystringОпциональный

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

ОбъектЗначение параметра
Категория тарифных плановplan_category

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

Название

Тип данных

Описание

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


id

integer

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


typestringТип данных

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


created_at

string

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



updated_at

string

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



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_category_publicbool

Признак Опубликована категории продукта:

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


product

string

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



plan_resources

object

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




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




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




typestringТип данных




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





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





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





namestring

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






measurablebool

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

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





unit_of_measurestring

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

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





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





includedinteger

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






minimuminteger

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






limitinteger

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






setup_feestring

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






recurring_feestring

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






overuse_feestring

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






renewal_feestring

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






unlimited_unitsbool

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

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





publicbool

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

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





statusstring

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

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





resource_idinteger

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






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





net_costsobject

Значения себестоимостей указанных типов для ресурса







setup_feestring

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







recurring_feestring

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







overuse_feestring

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







renewal_feestring

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






erpobject

Цена рекомендованная (ERP) ресурса







setup_feestring

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







recurring_feestring

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







overuse_feestring

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







renewal_feestring

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






custom_attributesobjectИнформация о дополнительных параметрах ресурса






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


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



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




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




typestringТип данных




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





created_atstring

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






updated_atstring

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






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





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





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





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





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





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





trialbool

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

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





publicbool

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

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





statusstring

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

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





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





endlessbool

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

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





net_costsobject

Значения себестоимостей указанных типов для периода







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






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






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






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





erpobjectЦена рекомендованная (ERP) периода






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






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






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






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


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


available_account_types

objectИнформация о типах клиентов, для которых доступен тарифный план



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




id

integer

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




typestringТип данных




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





created_at

string

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





updated_at

string

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





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





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





ancestrystringID родительского типа клиента





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





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





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





use_by_default


bool

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

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





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


custom_attributesobjectИнформация о дополнительных параметрах тарифного плана



custom_attributes.['custom_attribute_key']stringЗначение дополнительного параметра тарифного плана

relationshipsobjectИнформация о связанных объектах


plan_categoryobjectИнформация о связанной категории тарифных планов



dataobjectИнформация о категории тарифных планов




idstringID категории тарифных планов




typestringТип данных
includedarray of objects

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idstringID объекта
type

string

Тип данных
attributesobjectАтрибуты (состав данных см. ниже)

Для категории тарифных планов (см. Создание категории тарифных планов):

НазваниеТип данныхОписание
created_atstringДата и время создания категории тарифных планов

updated_at

stringДата и время последнего изменения категории тарифных планов
keystringУникальный ключ категории тарифных планов
namestringНазвание категории тарифных планов
descriptionstringОписание категории тарифных планов
priorityintegerПриоритет отображения категории тарифных планов
linksarrayСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу

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

GET /api/v3/resellers/1/plans/?page[size]=2&page[number]=78
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "367",
            "type": "plans",
            "attributes": {
                "created_at": "2017-07-07T10:06:26.669+03:00",
                "updated_at": "2019-11-22T14:13:51.378+03:00",
                "status": "active",
                "name": "test plan",
                "description": "",
                "public": true,
                "plan_class_id": 1300,
                "product_id": 403,
                "billing_type": "reservation",
                "ancestry": null,
                "reseller_id": 1,
                "fixed_price": true,
                "sku": "91fd106f-4b2c",
                "singleton": false,
                "auto_renewal": false,
                "auto_renewal_disabled": false,
                "plan_class": "test",
                "product_category_id": 190,
                "product_category": "default",
				"product_category_public": false,
                "product": "Default",
                "plan_resources": {
                    "data": [
                        {
                            "id": "2003",
                            "type": "plan_resources",
                            "attributes": {
                                "created_at": "2017-07-07T10:06:38.197+03:00",
                                "updated_at": "2017-07-07T10:06:38.197+03:00",
                                "name": "res2",
                                "measurable": false,
                                "unit_of_measure": "unit",
                                "application_template_name": "Auto provisioning",
                                "included": 0,
                                "minimum": 0,
                                "limit": 0,
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0",
                                "unlimited_units": false,
                                "public": true,
                                "status": "active",
                                "resource_id": 9,
                                "priority": 0,
                                "net_costs": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "overuse_fee": "0.0",
                                    "renewal_fee": "0.0"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "overuse_fee": "0.0",
                                    "renewal_fee": "0.0"
                                }, 
                                "custom_attributes": {}
                            }
                        },
                        {
                            "id": "2004",
                            "type": "plan_resources",
                            "attributes": {
                                "created_at": "2017-07-07T10:06:38.226+03:00",
                                "updated_at": "2017-07-07T10:06:38.226+03:00",
                                "name": "res3",
                                "measurable": false,
                                "unit_of_measure": "unit",
                                "application_template_name": "Auto provisioning",
                                "included": 0,
                                "minimum": 0,
                                "limit": 0,
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0",
                                "unlimited_units": false,
                                "public": true,
                                "status": "active",
                                "resource_id": 10,
                                "priority": 1,
                                "net_costs": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "overuse_fee": "0.0",
                                    "renewal_fee": "0.0"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "overuse_fee": "0.0",
                                    "renewal_fee": "0.0"
                                }, 
                                "custom_attributes": {}
                            }
                        }
                    ]
                },
                "plan_periods": {
                    "data": [
                        {
                            "id": "818",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2017-07-07T10:06:41.766+03:00",
                                "updated_at": "2017-07-07T10:06:41.766+03:00",
                                "duration_value": null,
                                "duration_type": null,
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0",
                                "trial": false,
                                "public": true,
                                "status": "active",
                                "description": null,
                                "endless": true,
                                "net_costs": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                }
                            }
                        }
                    ]
                },
                "available_account_types": {
                    "data": [
                        {
                            "id": "12",
                            "type": "account_types",
                            "attributes": {
                                "created_at": "2016-10-25T05:16:28.789779+0000",
                                "updated_at": "2017-02-01T12:04:39.227805+0000",
                                "reseller_id": 1,
                                "name": "Business",
                                "ancestry": null,
                                "default_payment_method_id": 197,
                                "key": "business",
                                "name_pattern": "%primary_name",
                                "use_by_default": false,
                                "primary_name": "Company name"
                            }
                        },
                        {
                            "id": "1564",
                            "type": "account_types",
                            "attributes": {
                                "created_at": "2017-03-20T13:34:28.163302+0000",
                                "updated_at": "2022-09-15T08:33:31.943006+0000",
                                "reseller_id": 1,
                                "name": "Personal",
                                "ancestry": "1562",
                                "default_payment_method_id": 2,
                                "key": "personal",
                                "name_pattern": "%first_name %middle_name %last_name",
                                "use_by_default": false,
                                "primary_name": ""
                            }
                        }
                    ]
                },
                "plan_currency": "RUB",
                "custom_attributes": {
                    "vat25": "0"
                }
            },
            "relationships": {
                "plan_category": {
                    "data": {
                        "id": "190",
                        "type": "plan_categories"
                    }
                }
            }
        },
        {
            "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_category_public": false,
                "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"
                                },
                                "erp": {
                                    "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": "Licenses",
                                "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"
                                },
                                "erp": {
                                    "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"
                                },
                                "erp": {
                                    "setup_fee": "0.0",
                                    "recurring_fee": "0.0",
                                    "transfer_fee": "0.0",
                                    "renewal_fee": "0.0"
                                }  
                            }
                        }
                    ]
                },
                "available_account_types": {
                    "data": [
                        {
                            "id": "12",
                            "type": "account_types",
                            "attributes": {
                                "created_at": "2016-10-25T05:16:28.789779+0000",
                                "updated_at": "2017-02-01T12:04:39.227805+0000",
                                "reseller_id": 1,
                                "name": "Business",
                                "ancestry": null,
                                "default_payment_method_id": 197,
                                "key": "business",
                                "name_pattern": "%primary_name",
                                "use_by_default": false,
                                "primary_name": "Company name"
                            }
                        },
                        {
                            "id": "1564",
                            "type": "account_types",
                            "attributes": {
                                "created_at": "2017-03-20T13:34:28.163302+0000",
                                "updated_at": "2022-09-15T08:33:31.943006+0000",
                                "reseller_id": 1,
                                "name": "Personal",
                                "ancestry": "1562",
                                "default_payment_method_id": 2,
                                "key": "personal",
                                "name_pattern": "%first_name %middle_name %last_name",
                                "use_by_default": false,
                                "primary_name": ""
                            }
                        }
                    ]
                },
                "plan_currency": "RUB",
                "custom_attributes": {}
            },
            "relationships": {
                "plan_category": {
                    "data": {
                        "id": "190",
                        "type": "plan_categories"
                    }
                }
            }
        }
    ],
    "links": {
        "self": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=78&page%5Bsize%5D=2",
        "first": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=77&page%5Bsize%5D=2",
        "next": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=79&page%5Bsize%5D=2",
        "last": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=242&page%5Bsize%5D=2"
    }
}