Получение списка Тарифных планов Реселлера
Метод Get a List of the Reseller's Plans используется для получения cписка Тарифных планов текущего Реселлера или любого из его нижестоящих Реселлеров.
Текущий Реселлер, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Менеджера, указанному в заголовке запроса.
GET {base_url}/api/v3/resellers/{reseller_id}/plansАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
| Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности |
| Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) |
| reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) |
page[size] | query | integer | Опциональный | Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) |
page[number] | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа |
Модель ответа
Название | Тип данных | Описание | ||||||
|---|---|---|---|---|---|---|---|---|
| data | array | Данные ответа | ||||||
id | integer | ID Тарифного плана | ||||||
| type | string | Тип данных | ||||||
| attributes | object | Информация о Тарифном плане | ||||||
created_at | date | Дата и время создания Тарифного плана | ||||||
updated_at | date | Дата и время последнего изменения Тарифного плана | ||||||
| status | string | Статус Тарифного плана (список статусов см. в Просмотр списка тарифных планов) | ||||||
name | string | Название Тарифного плана | ||||||
description | string | Дополнительная информация о Тарифном плане, которая отображается клиентам в Панели управления Клиента | ||||||
public | bool | Признак доступности Тарифного плана:
| ||||||
plan_class_id | integer | ID Правила предоставления (см. Управление правилами предоставления тарифных планов) | ||||||
product_id | integer | ID Продукта, с которым связан Тарифный план | ||||||
| billing_type | string | Тип биллинга Тарифного плана | ||||||
| ancestry | string | Для делегированных Тарифных планов содержит список ID родительских Тарифных планов, начиная от корневого (см. Просмотр списка делегированных тарифных планов). Для Тарифных планов, созданных Сотрудником выбранного Реселлера равен null | ||||||
| reseller_id | integer | ID Реселлера, которому принадлежит Тарифный план | ||||||
plan_class | string | Название Правила предоставления | ||||||
product_category_id | integer | ID Категории продукта, с которой связан Тарифный план | ||||||
product_category | string | Название Категории продукта, с которой связан Тарифный план | ||||||
product | string | Название Продукта, с которым связан Тарифный план | ||||||
plan_resources | array of objects | Информация о Ресурсах Тарифного плана | ||||||
| data | array | Данные объекта | ||||||
| id | integer | ID Ресурса в Шаблоне услуги | ||||||
| type | string | Тип данных | ||||||
| attributes | object | Информация о Ресурсах Тарифного плана | ||||||
| created_at | date | Дата и время создания Ресурса | ||||||
| updated_at | date | Дата и время последнего обновления Ресурса | ||||||
| name | string | Название Ресурса | ||||||
| measurable | bool | Признак использования модели расчета стоимости за фактическое использование Ресурса (недоступен, если функция не поддерживается внешними службами):
| ||||||
| unit_of_measure | string | Единица измерения Ресурса:
| ||||||
| application_template_name | string | Название Услуги, которая предоставляется в рамках данного Тарифного плана | ||||||
| included | integer | Количество Ресурса, которое включено в Тарифный план по умолчанию (включенные Ресурсы входят в стоимость Подписки) | ||||||
| minimum | integer | Минимальное количество Ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана) | ||||||
| limit | integer | Максимальное количество Ресурса, доступное для заказа. Если Ресурс безлимитный (признак unlimited_units=true), то limit принимает значение 0. Limit может быть также равен 0 когда Ресурс не является безлимитным, если minimum и limit одновременно равны 0 | ||||||
| setup_fee | float | Величина платежа за установку Ресурса | ||||||
| recurring_fee | float | Величина ежемесячной абонентской платы за Ресурс | ||||||
| overuse_fee | float | Стоимость перерасхода Ресурсов | ||||||
| renewal_fee | float | Стоимость продления использования Ресурса | ||||||
| unlimited_units | bool | Признак отключения лимитов использования Ресурса:
| ||||||
| public | bool | Возможные значения:
| ||||||
| status | string | Статус Ресурса:
| ||||||
| resource_id | integer | ID Ресурса Тарифного плана | ||||||
| custom_attributes | array of objects | Информация о Дополнительных параметрах Ресурса | ||||||
| plan_resources.custom_attributes.['custom-attribute-key'] | string | Значение Дополнительного параметра Ресурса | ||||||
| plan_periods | array of objects | Информация о периодах Тарифного плана | ||||||
| data | array | Данные объекта | ||||||
| id | integer | ID периода Тарифного плана | ||||||
| type | string | Тип данных | ||||||
| attributes | object | Информация о периодах Тарифного плана | ||||||
| created_at | date | Дата и время создания периода Тарифного плана | ||||||
| updated_at | date | Дата и время последнего обновления периода Тарифного плана | ||||||
| duration_value | integer | Длительность периода Тарифного плана | ||||||
| duration_type | string | Единица измерения периода Тарифного плана | ||||||
| setup_fee | float | Стоимость установки Тарифного плана для данного периода | ||||||
| recurring_fee | float | Ежемесячная стоимость Тарифного плана для данного периода | ||||||
| transfer_fee | float | Стоимость переноса Домена, если Услуги включает в себя возможность использования Доменов | ||||||
| renewal_fee | float | Стоимость продления Тарифного плана для данного периода | ||||||
| trial | bool | Признак того, является ли период Тарифного плана пробным:
| ||||||
| public | bool | Признак доступности периода для заказа в рамках данного Тарифного плана:
| ||||||
| status | string | Статус периода Тарифного плана:
| ||||||
| description | string | Описание периода Тарифного плана | ||||||
available_account_types | array of objects | Информация о Типах клиентов | ||||||
| id | integer | ID Типа клиента | ||||||
| name | string | Имя Типа клиента | ||||||
| created_at | date | Дата и время создания Типа клиента | ||||||
| updated_at | date | Дата и время последнего обновления Типа клиента | ||||||
| reseller_id | integer | ID Реселлера, к которому относится Тип клиента | ||||||
| name_pattern | string | Шаблон отображения имени Клиента в платформе | ||||||
| primary_name | string | Название поля с основным именем Клиента. Например, для Типа клиента Юридическое лицо это может быть Название компании | ||||||
| key | string | Ключ Типа клиентов | ||||||
| default_payment_method_id | integer | ID способа оплаты (см. Способы оплаты), который используется по умолчанию для данного Типа клиентов | ||||||
| ancestry | integer | ID родительского Типа клиентов | ||||||
| custom-attributes | object | Информация о Дополнительных параметрах Тарифного плана | ||||||
| custom-attributes.['custom-attribute-key'] | string | Значение Дополнительного параметра Тарифного плана | ||||||
| links | array | Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации | ||||||
| self | string | Ссылка на текущую страницу | ||||||
| first | string | Ссылка на первую страницу | ||||||
| prev | string | Ссылка на предыдущую страницу | ||||||
| next | string | Ссылка на следующую страницу | ||||||
| last | string | Ссылка на последнюю страницу | ||||||
Пример запроса
GET /api/v3/resellers/1/plans/?page[size]=2&page[number]=12
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": [
{
"id": "33",
"type": "plans",
"attributes": {
"created_at": "2016-10-26T14:59:49.693+03:00",
"updated_at": "2016-10-26T15:02:59.939+03:00",
"status": "active",
"name": "Регистрация домена .net",
"description": "",
"public": true,
"plan_class_id": 1,
"product_id": 403,
"billing_type": "reservation",
"ancestry": null,
"reseller_id": 1,
"plan_class": "default",
"product_category_id": 190,
"product_category": "default",
"product": "Default",
"plan_resources": {
"data": [
{
"id": "843",
"type": "plan_resources",
"attributes": {
"created_at": "2016-11-02T16:19:00.869+03:00",
"updated_at": "2016-12-29T12:25:20.812+03:00",
"name": "WHOIS Privacy",
"measurable": false,
"unit_of_measure": "boolean",
"application_template_name": "Домен зоны .net",
"included": 0,
"minimum": 0,
"limit": 1,
"setup_fee": "1.0",
"recurring_fee": "0.0",
"overuse_fee": "0.0",
"renewal_fee": "0.0",
"unlimited_units": null,
"public": true,
"status": "active",
"resource_id": 316,
"custom_attributes": {
"item_1c_id": "",
"item_1c_for_resellers": ""
}
}
}
]
},
"plan_periods": {
"data": [
{
"id": "159",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-26T15:02:55.093+03:00",
"updated_at": "2016-12-29T12:23:12.325+03:00",
"duration_value": 1,
"duration_type": "year",
"setup_fee": "1.0",
"recurring_fee": "10.0",
"transfer_fee": "0.0",
"renewal_fee": "3.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "160",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-26T15:02:55.113+03:00",
"updated_at": "2016-12-29T12:23:12.504+03:00",
"duration_value": 3,
"duration_type": "year",
"setup_fee": "1.0",
"recurring_fee": "7.0",
"transfer_fee": "0.0",
"renewal_fee": "2.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "161",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-26T15:02:55.132+03:00",
"updated_at": "2016-12-29T12:23:12.691+03:00",
"duration_value": 5,
"duration_type": "year",
"setup_fee": "1.0",
"recurring_fee": "5.0",
"transfer_fee": "0.0",
"renewal_fee": "1.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
}
]
},
"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
},
{
"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
},
{
"id": 12,
"name": "Business w/o НДС",
"created_at": "2016-10-25T08:16:28.789+03:00",
"updated_at": "2017-02-01T15:04:39.227+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business_wo_vat",
"default_payment_method_id": 197,
"ancestry": null
},
{
"id": 512,
"name": "IP BLR",
"created_at": "2017-01-26T10:02:02.908+03:00",
"updated_at": "2017-02-01T17:25:58.465+03:00",
"reseller_id": 1,
"name_pattern": "%last_name %first_name %middle_name",
"primary_name": "",
"key": "ip",
"default_payment_method_id": 197,
"ancestry": null
},
{
"id": 651,
"name": "business w/o vat",
"created_at": "2017-01-31T15:58:27.121+03:00",
"updated_at": "2017-01-31T15:58:27.121+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "",
"key": "business_no_vat",
"default_payment_method_id": null,
"ancestry": null
},
{
"id": 1124,
"name": "Test1",
"created_at": "2017-02-02T18:08:39.408+03:00",
"updated_at": "2017-02-02T18:19:18.433+03:00",
"reseller_id": 1,
"name_pattern": "test1",
"primary_name": "",
"key": "test1",
"default_payment_method_id": null,
"ancestry": null
},
{
"id": 1158,
"name": "Test2",
"created_at": "2017-02-02T18:08:57.298+03:00",
"updated_at": "2017-02-02T18:08:57.298+03:00",
"reseller_id": 1,
"name_pattern": "Test2",
"primary_name": "",
"key": "Test2",
"default_payment_method_id": null,
"ancestry": null
},
{
"id": 1192,
"name": "test3",
"created_at": "2017-02-02T18:09:17.418+03:00",
"updated_at": "2019-01-04T16:56:34.724+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "test3",
"default_payment_method_id": 1325,
"ancestry": null
},
{
"id": 1284,
"name": "test 8",
"created_at": "2017-02-03T10:42:43.517+03:00",
"updated_at": "2017-02-03T10:42:43.517+03:00",
"reseller_id": 1,
"name_pattern": "test8",
"primary_name": "",
"key": "test8",
"default_payment_method_id": null,
"ancestry": null
},
{
"id": 1385,
"name": "Индивидуальный предприниматель",
"created_at": "2017-02-08T11:25:32.739+03:00",
"updated_at": "2017-02-08T15:25:04.689+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "key",
"default_payment_method_id": 2,
"ancestry": null
},
{
"id": 1564,
"name": "Физическое лицо",
"created_at": "2017-03-20T16:34:28.163+03:00",
"updated_at": "2017-03-20T16:34:28.163+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personal",
"default_payment_method_id": null,
"ancestry": "1562"
},
{
"id": 1602,
"name": "Юридическое лицо",
"created_at": "2017-03-21T10:48:13.152+03:00",
"updated_at": "2017-03-21T10:48:13.152+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business",
"default_payment_method_id": null,
"ancestry": "1600"
},
{
"id": 1930,
"name": "Business1",
"created_at": "2017-05-30T13:31:14.325+03:00",
"updated_at": "2017-05-30T13:31:14.325+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business1",
"default_payment_method_id": null,
"ancestry": "1900"
}
],
"custom_attributes": {
"item_1c_id": ""
}
}
},
{
"id": "34",
"type": "plans",
"attributes": {
"created_at": "2016-10-26T15:04:12.167+03:00",
"updated_at": "2019-08-05T07:43:33.598+03:00",
"status": "active",
"name": "Регистрация домена .бел",
"description": "",
"public": true,
"plan_class_id": 1,
"product_id": 403,
"billing_type": "reservation",
"ancestry": null,
"reseller_id": 1,
"plan_class": "default",
"product_category_id": 190,
"product_category": "default",
"product": "Default",
"plan_resources": {
"data": [
{
"id": "3499",
"type": "plan_resources",
"attributes": {
"created_at": "2020-02-06T11:16:38.446+03:00",
"updated_at": "2020-02-06T11:16:49.059+03:00",
"name": "WHOIS Privacy",
"measurable": false,
"unit_of_measure": "boolean",
"application_template_name": "Домен зоны .бел",
"included": 0,
"minimum": 0,
"limit": 1,
"setup_fee": "0.0",
"recurring_fee": "0.0",
"overuse_fee": "0.0",
"renewal_fee": "0.0",
"unlimited_units": null,
"public": true,
"status": "active",
"resource_id": 315,
"custom_attributes": {
"item_1c_id": "11111",
"v_resource": ""
}
}
}
]
},
"plan_periods": {
"data": [
{
"id": "162",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-26T15:05:31.209+03:00",
"updated_at": "2016-12-29T12:23:12.873+03:00",
"duration_value": 1,
"duration_type": "year",
"setup_fee": "1.0",
"recurring_fee": "5.0",
"transfer_fee": "0.0",
"renewal_fee": "3.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "163",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-26T15:05:31.229+03:00",
"updated_at": "2016-12-29T12:23:13.177+03:00",
"duration_value": 3,
"duration_type": "year",
"setup_fee": "1.0",
"recurring_fee": "3.0",
"transfer_fee": "0.0",
"renewal_fee": "2.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "164",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-26T15:05:31.249+03:00",
"updated_at": "2016-12-29T12:23:13.367+03:00",
"duration_value": 5,
"duration_type": "year",
"setup_fee": "1.0",
"recurring_fee": "2.0",
"transfer_fee": "0.0",
"renewal_fee": "1.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "393",
"type": "plan_periods",
"attributes": {
"created_at": "2016-10-31T04:03:39.519+03:00",
"updated_at": "2016-12-29T12:23:14.263+03:00",
"duration_value": 3,
"duration_type": "month",
"setup_fee": "1.0",
"recurring_fee": "2.0",
"transfer_fee": "0.0",
"renewal_fee": "2.0",
"trial": false,
"public": true,
"status": "active",
"description": ""
}
}
]
},
"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
},
{
"id": 12,
"name": "Business w/o НДС",
"created_at": "2016-10-25T08:16:28.789+03:00",
"updated_at": "2017-02-01T15:04:39.227+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business_wo_vat",
"default_payment_method_id": 197,
"ancestry": null,
"use_by_default": false
},
{
"id": 512,
"name": "IP BLR",
"created_at": "2017-01-26T10:02:02.908+03:00",
"updated_at": "2017-02-01T17:25:58.465+03:00",
"reseller_id": 1,
"name_pattern": "%last_name %first_name %middle_name",
"primary_name": "",
"key": "ip",
"default_payment_method_id": 197,
"ancestry": null,
"use_by_default": false
},
{
"id": 651,
"name": "business w/o vat",
"created_at": "2017-01-31T15:58:27.121+03:00",
"updated_at": "2017-01-31T15:58:27.121+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "",
"key": "business_no_vat",
"default_payment_method_id": null,
"ancestry": null,
"use_by_default": false
},
{
"id": 1124,
"name": "Test1",
"created_at": "2017-02-02T18:08:39.408+03:00",
"updated_at": "2017-02-02T18:19:18.433+03:00",
"reseller_id": 1,
"name_pattern": "test1",
"primary_name": "",
"key": "test1",
"default_payment_method_id": null,
"ancestry": null,
"use_by_default": false
},
{
"id": 1158,
"name": "Test2",
"created_at": "2017-02-02T18:08:57.298+03:00",
"updated_at": "2017-02-02T18:08:57.298+03:00",
"reseller_id": 1,
"name_pattern": "Test2",
"primary_name": "",
"key": "Test2",
"default_payment_method_id": null,
"ancestry": null,
"use_by_default": false
},
{
"id": 1192,
"name": "test3",
"created_at": "2017-02-02T18:09:17.418+03:00",
"updated_at": "2019-01-04T16:56:34.724+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "test3",
"default_payment_method_id": 1325,
"ancestry": null,
"use_by_default": false
},
{
"id": 1284,
"name": "test 8",
"created_at": "2017-02-03T10:42:43.517+03:00",
"updated_at": "2017-02-03T10:42:43.517+03:00",
"reseller_id": 1,
"name_pattern": "test8",
"primary_name": "",
"key": "test8",
"default_payment_method_id": null,
"ancestry": null,
"use_by_default": false
},
{
"id": 1385,
"name": "Индивидуальный предприниматель",
"created_at": "2017-02-08T11:25:32.739+03:00",
"updated_at": "2017-02-08T15:25:04.689+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "key",
"default_payment_method_id": 2,
"ancestry": null,
"use_by_default": false
},
{
"id": 1564,
"name": "Физическое лицо",
"created_at": "2017-03-20T16:34:28.163+03:00",
"updated_at": "2017-03-20T16:34:28.163+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personal",
"default_payment_method_id": null,
"ancestry": "1562",
"use_by_default": false
},
{
"id": 1602,
"name": "Юридическое лицо",
"created_at": "2017-03-21T10:48:13.152+03:00",
"updated_at": "2017-03-21T10:48:13.152+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business",
"default_payment_method_id": null,
"ancestry": "1600",
"use_by_default": false
},
{
"id": 1930,
"name": "Business1",
"created_at": "2017-05-30T13:31:14.325+03:00",
"updated_at": "2017-05-30T13:31:14.325+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business1",
"default_payment_method_id": null,
"ancestry": "1900",
"use_by_default": false
}
],
"custom_attributes": {
"item_1c_id": "12345",
"item_1c_for_resellers": "12345",
"vat25": "0",
"attribute_2": "",
"uniqueness": ""
}
}
}
],
"links": {
"self": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=12&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=11&page%5Bsize%5D=2",
"next": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=13&page%5Bsize%5D=2",
"last": "http://test.activeplatform.com/api/v3/resellers/1/plans/?page%5Bnumber%5D=223&page%5Bsize%5D=2"
}
}