Получение списка подписок
Метод Get list of subscriptions используется для получения списка подписок текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/subscriptions
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||||||||||
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json | ||||||||||
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json | ||||||||||
base_url | path | string | Обязательный | URL ActivePlatform | ||||||||||
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | ||||||||||
page[size] | query | integer | Опциональный | Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) | ||||||||||
page[number] | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа | ||||||||||
meta | query | bool | Опциональный | Запрос дополнительных атрибутов подписки | ||||||||||
filter[account_id] | query | string | Опциональный | Предназначен для фильтрации списка подписок по ID клиента. Допускается указание нескольких значений, разделенных запятой | ||||||||||
filter[status] | query | string | Опциональный | Предназначен для фильтрации списка подписок по статусу. Допускается указание нескольких значений, разделенных запятой | ||||||||||
filter[payment_model] | query | string | Опциональный | Предназначен для фильтрации списка подписок по модели оплаты. Возможные значения:
| ||||||||||
filter[trial] | query | bool | Опциональный | Предназначен для фильтрации списка подписок по признаку Пробная. Возможные значения:
| ||||||||||
filter[plan_id] | query | string | Опциональный | Предназначен для фильтрации списка подписок по ID тарифного плана. Допускается указание нескольких значений, разделенных запятой | ||||||||||
filter[created_at] | query | string | Опциональный | Предназначен для фильтрации списка подписок по дате и времени создания в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
| ||||||||||
filter[updated_at] | query | string | Опциональный | Предназначен для фильтрации списка подписок по дате и времени последнего обновления в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
| ||||||||||
filter[start_date] | query | string | Опциональный | Предназначен для фильтрации списка подписок по дате начала в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры:
| ||||||||||
filter[expiration_date] | query | string | Опциональный | Предназначен для фильтрации списка подписок по дате истечения в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры:
| ||||||||||
filter[custom_price] | query | bool | Опциональный | Предназначен для фильтрации списка подписок по признаку Индивидуальная цена. Возможные значения:
| ||||||||||
sort | query | string | Опциональный | Предназначен для сортировки подписок по указанному параметру:
В качестве
| ||||||||||
include | query | string | Опциональный | Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:
|
Модель ответа
Название | Тип данных | Описание | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | array | Данные ответа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | ID подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Тип данных | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attributes | object | Информация о подписке (см. Просмотр и обновление информации о подписке) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string | Дата и время создания подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string | Дата и время последнего изменения подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plan_id | integer | ID тарифного плана подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | integer | ID клиента, которому принадлежит подписка | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | Название подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trial | bool | Является ли данная подписка пробной:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | Статус подписки (список статусов см. в Просмотр списка подписок) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
start_date | string | Дата активации подписки (ГГГГ-ММ-ДД) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expiration_date | string | Дата истечения срока действия подписки (ГГГГ-ММ-ДД) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plan_period_id | integer | ID периода тарифного плана | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promo_code | string | Код, который был использован для получения скидки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_settings | object | Информация о параметрах продления подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autorenew | bool | Активирована ли опция Автопродление для подписки:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disable_autorenew | bool | Доступность для изменения опции Автопродление подписки:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autorenew_point | integer | Точка автоматического продления (в днях) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manual_renew_point | integer | Точка ручного продления (в днях) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_model | string | Модель оплаты подписки. Возможные значения:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_model_parameters | object | Параметры модели оплаты подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
credit_limit | number | Величина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_debt | number | Величина текущей задолженности по подписке. Возвращается только для payment_model = postpay | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fixed_price | bool | Значение признака Фиксированная цена в заказанном тарифном плане (см. Общая информация о тарифном плане):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ability | object | Список доступных действий над подпиской | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stop | bool | Остановка подписки (см. Остановка подписки):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activate | bool | Активация подписки (см. Активация подписки):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
destroy | bool | Удаление подписки (см. Удаление подписки):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adjust | bool | Изменение количества ресурсов подписки (см. Создание заказа на изменение количества ресурсов):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
immediate_switch_plan_order | bool | Немедленное переключение тарифного плана подписки (см. Создание заказа на переключение):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
delayed_switch_plan_order | bool | Отложенное переключение тарифного плана подписки (см. Создание заказа на переключение):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renew | bool | Продление подписки вручную (см. Создание заказа на продление):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
change_auto_renew_option | bool | Изменение опции Автопродление подписки (см. Обновление подписки):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prolong | bool | Пролонгация подписки вручную (см. Создание заказа на пролонгацию):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
change_resources_renewal_order | bool | Изменение количества ресурсов подписки в заказе на продление (см. Отложенное продление подписки в ActivePlatform. Панель управления Оператора):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decrease_resources_change_order | bool | Уменьшение количества ресурсов подписки в заказе на изменение количества ресурсов (см. Изменение количества ресурсов подписки в ActivePlatform. Панель управления Оператора):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decrease_resources_prolong_order | bool | Уменьшение количества ресурсов подписки в заказе на пролонгацию (см. Пролонгация подписки в ActivePlatform. Панель управления Оператора):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_price | bool | Признак индивидуальной цены (см. Заказ на покупку подписки в ActivePlatform. Панель управления Оператора):
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relationships | object | Перечень объектов, связанных с подпиской | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account | object | Информация о клиенте, которому принадлежит подписка | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | object | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_resources | object | Информация о ресурсах подписки, доступных для заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_period | object | Информация о периоде, на который заказана подписка | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | object | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plan | object | Информация о тарифном плане подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | object | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meta | object | Дополнительные атрибуты подписки (см. Просмотр информации об экземпляре услуги в разделе Подписки в Просмотр информации об экземпляре услуги) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applications | array | Перечень дополнительных атрибутов подписки. Зависит от конкретной подписки | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
'attribute.name' | string | Значение атрибута | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
included | array | Дополнительная информация о связанных объектах, указанных в запросе:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
links | object | Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
self | string | Ссылка на текущую страницу | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
first | string | Ссылка на первую страницу | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prev | string | Ссылка на предыдущую страницу | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next | string | Ссылка на следующую страницу | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last | string | Ссылка на последнюю страницу |
Пример запроса
GET /api/v3/resellers/1/subscriptions?meta=true&page[size]=2&page[number]=2610&include=account,plan,subscription_period,subscription_resources
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": [
{
"id": "3007095",
"type": "subscriptions",
"attributes": {
"created_at": "2020-08-05T05:44:55.355+03:00",
"updated_at": "2020-08-05T06:26:53.948+03:00",
"plan_id": 1200,
"account_id": 523,
"name": "1200 G Suite Business test.activeplatform.com",
"trial": false,
"status": "active",
"start_date": "2020-08-05",
"expiration_date": "2020-09-05",
"plan_period_id": 2014,
"promo_code": null,
"payment_model": "prepay",
"payment_model_parameters": {},
"renewal_settings": {
"autorenew": false,
"disable_autorenew": false,
"autorenew_point": 0,
"manual_renew_point": 0
},
"fixed_price": false,
"ability": {
"stop": true,
"activate": false,
"destroy": true,
"adjust": true,
"immediate_switch_plan_order": false,
"delayed_switch_plan_order": false,
"renew": false,
"change_auto_renew_option": true,
"prolong": false,
"change_resources_renewal_order": true,
"decrease_resources_change_order": false,
"decrease_resources_prolong_order": false
},
"custom_price": false
},
"relationships": {
"account": {
"data": {
"id": "523",
"type": "accounts"
}
},
"subscription_resources": {
"data": [
{
"id": "34847",
"type": "subscription_resources"
}
]
},
"subscription_period": {
"data": {
"id": "6200",
"type": "subscription_periods"
}
},
"plan": {
"data": {
"id": "1200",
"type": "plans"
}
}
},
"meta": {
"applications": [
{
"user_manual": "<h3>G Suite activation steps</h3><br><ul><li>1. Go to the account admin console <a class=\"link\" href=\"https://admin.google.com\" target=\"blank\">https://admin.google.com</a> using the credentials below.<li><li>2. Accept the G Suite Agreement.<li><li>3. Create a new, strong password for your G Suite Account.<li><li>4. Accept the Term of Service.<li><li>5. Verify your domain to activate G Suite using the \"Start Setup\" button.</li></ul>",
"customer_id": "new1",
"admin_login": "admin",
"domain_name": "test.activeplatform.com",
"first_password": "pass123",
"plugin_name": "Vendor service"
}
]
}
},
{
"id": "3007096",
"type": "subscriptions",
"attributes": {
"created_at": "2020-08-11T08:15:18.760+03:00",
"updated_at": "2020-08-11T08:15:58.394+03:00",
"plan_id": 804,
"account_id": 685,
"name": "CSP monthly",
"trial": false,
"status": "active",
"start_date": "2020-08-11",
"expiration_date": "2022-08-11",
"plan_period_id": 1614,
"promo_code": null,
"payment_model": "prepay",
"payment_model_parameters": {},
"renewal_settings": {
"autorenew": false,
"disable_autorenew": false,
"autorenew_point": 0,
"manual_renew_point": -1
},
"fixed_price": false,
"ability": {
"stop": true,
"activate": false,
"destroy": true,
"adjust": true,
"immediate_switch_plan_order": false,
"delayed_switch_plan_order": false,
"renew": true,
"change_auto_renew_option": true,
"prolong": true,
"change_resources_renewal_order": true,
"decrease_resources_change_order": true,
"decrease_resources_prolong_order": true
},
"custom_price": false
},
"relationships": {
"account": {
"data": {
"id": "685",
"type": "accounts"
}
},
"subscription_resources": {
"data": [
{
"id": "34848",
"type": "subscription_resources"
}
]
},
"subscription_period": {
"data": {
"id": "6201",
"type": "subscription_periods"
}
},
"plan": {
"data": {
"id": "804",
"type": "plans"
}
}
},
"meta": {
"applications": []
}
}
],
"included": [
{
"id": "523",
"type": "accounts",
"attributes": {
"created_at": "2019-08-20T04:38:39.065+03:00",
"updated_at": "2020-08-05T05:44:06.676+03:00",
"reseller_id": 1,
"name": "Test company 2",
"account_class_id": 1,
"primary_name": "Test company 2",
"first_name": "Natal",
"middle_name": "Yur",
"last_name": "Smith",
"country": "US",
"region": "NY",
"city": "Brooklyn",
"street": "Westminister ave.",
"building": "w",
"office": "",
"zip": "11000",
"phone": "+15551144108",
"email": "test@xample.com",
"status": "active",
"balance": "9066.03",
"usable_balance": "9051.33",
"current_debt": 0,
"subscription_credit_limit": 8800,
"financial_blocking_threshold": 4000,
"account_type_id": 1602,
"manager_id": null,
"owner_id": 949,
"tech_user_id": 949,
"bill_user_id": 949,
"custom_attributes": {
"test_attr": "",
"inn": "",
"unp_test": "",
"position": "manager"
},
"manager": null,
"owner": {
"created_at": "2020-08-05T05:43:26.424+03:00",
"updated_at": "2020-08-05T05:43:26.427+03:00",
"email": "test@xample.com",
"account_status": "active",
"global_status": "active",
"first_name": "Tan",
"middle_name": "J",
"last_name": "Owner"
},
"default_payment_model": "prepay",
"account_type": {
"id": 1602,
"name": "Юридическое лицо",
"created_at": "2017-03-21T10:48:13.152+03:00",
"updated_at": "2020-05-05T12:58:44.367+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business",
"default_payment_method_id": 1,
"ancestry": "1600",
"use_by_default": false
},
"account_class": {
"id": 1,
"reseller_id": 1,
"name": "Default",
"created_at": "2016-08-25T09:26:12.820+03:00",
"updated_at": "2020-04-03T10:50:35.132+03:00",
"financial_blocking_threshold": "4000.0",
"due_order_period": 90,
"subzero_period": 1,
"stop_subscription_type": "automatically",
"key": "default",
"color": "grey",
"guaranteed_payment_limit": 1000,
"guaranteed_payment_period": 7,
"delete_subscription_type": "automatically",
"denominated": false,
"buy_with_negative_balance": true,
"receipt_day": null,
"payment_model": "prepay",
"default": false,
"due_payment_period": 3,
"subscription_credit_limit": "8800.0"
}
},
"relationships": {
"subscriptions": {
"data": [
{
"id": "3007095",
"type": "subscriptions"
},
{
"id": "3007094",
"type": "subscriptions"
}
]
}
}
},
{
"id": "34847",
"type": "subscription_resources",
"attributes": {
"created_at": "2020-08-05T05:44:55.357+03:00",
"updated_at": "2020-08-05T06:26:49.047+03:00",
"name": "User",
"measurable": null,
"unit_of_measure": "unit",
"application_template_name": "G Suite",
"included": 0,
"minimum": 1,
"limit": 750,
"additional": 2,
"priority": 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": 1494,
"custom_attributes": {
"item_1c_id": ""
}
}
},
{
"id": "6200",
"type": "subscription_periods",
"attributes": {
"created_at": "2020-08-05T05:44:55.358+03:00",
"updated_at": "2020-08-05T05:44:55.358+03:00",
"duration_value": 1,
"duration_type": "month",
"setup_fee": "0.0",
"recurring_fee": "0.0",
"transfer_fee": "0.0",
"renewal_fee": "0.0",
"endless": false,
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "1200",
"type": "plans",
"attributes": {
"created_at": "2019-04-21T10:36:06.141+03:00",
"updated_at": "2020-08-05T07:45:46.451+03:00",
"status": "inactive",
"name": "G Suite Business",
"description": "G Suite Business – Google",
"public": false,
"plan_class_id": 10158,
"product_id": 575,
"billing_type": "g_suite",
"ancestry": null,
"reseller_id": 1,
"fixed_price": false,
"plan_class": "G Suite",
"product_category_id": 190,
"product_category": "default",
"product": "G Suite",
"plan_resources": {
"data": [
{
"id": "3463",
"type": "plan_resources",
"attributes": {
"created_at": "2019-04-21T10:36:06.192+03:00",
"updated_at": "2019-11-02T02:47:50.871+03:00",
"name": "User",
"measurable": null,
"unit_of_measure": "unit",
"application_template_name": "G Suite",
"included": 0,
"minimum": 1,
"limit": 750,
"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": 1494,
"custom_attributes": {
"item_1c_id": ""
}
}
}
]
},
"plan_periods": {
"data": [
{
"id": "2014",
"type": "plan_periods",
"attributes": {
"created_at": "2019-04-21T10:36:06.214+03:00",
"updated_at": "2019-04-21T10:36:06.214+03:00",
"duration_value": 1,
"duration_type": "month",
"setup_fee": "0.0",
"recurring_fee": "0.0",
"transfer_fee": "0.0",
"renewal_fee": "0.0",
"trial": false,
"public": true,
"status": "active",
"description": null
}
},
{
"id": "2020",
"type": "plan_periods",
"attributes": {
"created_at": "2019-05-03T14:20:04.124+03:00",
"updated_at": "2019-05-03T14:20:04.124+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": ""
}
}
]
},
"available_account_types": [
{
"id": 1564,
"name": "Физическое лицо",
"created_at": "2017-03-20T16:34:28.163+03:00",
"updated_at": "2020-05-05T13:01:02.962+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personal",
"default_payment_method_id": 2,
"ancestry": "1562",
"use_by_default": false
},
{
"id": 1602,
"name": "Юридическое лицо",
"created_at": "2017-03-21T10:48:13.152+03:00",
"updated_at": "2020-05-05T12:58:44.367+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business",
"default_payment_method_id": 1,
"ancestry": "1600",
"use_by_default": false
}
],
"plan_currency": "RUB",
"custom_attributes": {
"item_1c_id": ""
}
}
},
{
"id": "685",
"type": "accounts",
"attributes": {
"created_at": "2020-08-11T15:07:51.626+03:00",
"updated_at": "2020-08-11T08:15:58.256+03:00",
"reseller_id": 1,
"name": "Kate Sat",
"account_class_id": 1359,
"primary_name": "",
"first_name": "Kate",
"middle_name": "",
"last_name": "Sat",
"country": "RU",
"region": "Minsk",
"city": "Minsk",
"street": "Kalvariiskaya",
"building": "",
"office": "",
"zip": "123456",
"phone": "+37596666666",
"email": "test@gmail.com",
"status": "active",
"balance": "191.15",
"usable_balance": "87.0",
"current_debt": 107.68,
"subscription_credit_limit": 503333,
"financial_blocking_threshold": 0,
"account_type_id": 1564,
"manager_id": null,
"owner_id": 946,
"tech_user_id": 946,
"bill_user_id": 946,
"custom_attributes": {
"signer_first_name": "",
"signer_last_name": "",
"signer_email": "",
"position": "manager"
},
"manager": null,
"owner": {
"created_at": "2020-08-11T15:07:51.603+03:00",
"updated_at": "2020-08-11T15:07:51.997+03:00",
"email": "test@gmail.com",
"account_status": "active",
"global_status": "active",
"first_name": "Kate",
"middle_name": null,
"last_name": "Sat"
},
"default_payment_model": "postpay",
"account_type": {
"id": 1564,
"name": "Физическое лицо",
"created_at": "2017-03-20T16:34:28.163+03:00",
"updated_at": "2020-05-05T13:01:02.962+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personal",
"default_payment_method_id": 2,
"ancestry": "1562",
"use_by_default": false
},
"account_class": {
"id": 1359,
"reseller_id": 1,
"name": "postpay",
"created_at": "2024-12-06T07:15:46.138+03:00",
"updated_at": "2019-06-10T09:40:45.888+03:00",
"financial_blocking_threshold": "0.0",
"due_order_period": 7,
"subzero_period": -1,
"stop_subscription_type": "automatically",
"key": "postpay___",
"color": "orange",
"guaranteed_payment_limit": 1000,
"guaranteed_payment_period": 7,
"delete_subscription_type": "automatically",
"denominated": false,
"buy_with_negative_balance": true,
"receipt_day": null,
"payment_model": "postpay",
"default": false,
"due_payment_period": 5,
"subscription_credit_limit": "50.0"
}
},
"relationships": {
"subscriptions": {
"data": [
{
"id": "3007096",
"type": "subscriptions"
},
{
"id": "3007056",
"type": "subscriptions"
}
]
}
}
},
{
"id": "34848",
"type": "subscription_resources",
"attributes": {
"created_at": "2020-08-11T08:15:18.763+03:00",
"updated_at": "2020-08-11T08:15:26.441+03:00",
"name": "res3",
"measurable": null,
"unit_of_measure": "unit",
"application_template_name": "auto prov new",
"included": 5,
"minimum": 5,
"limit": 0,
"additional": 1,
"priority": 0,
"setup_fee": "0.0",
"recurring_fee": "50.0",
"overuse_fee": "0.0",
"renewal_fee": "0.0",
"unlimited_units": true,
"public": true,
"status": "active",
"resource_id": 1427,
"custom_attributes": {
"item_1c_id": "",
"vendor_short_name": ""
}
}
},
{
"id": "6201",
"type": "subscription_periods",
"attributes": {
"created_at": "2020-08-11T08:15:18.767+03:00",
"updated_at": "2020-08-11T08:15:18.767+03:00",
"duration_value": 1,
"duration_type": "year",
"setup_fee": "0.0",
"recurring_fee": "0.0",
"transfer_fee": "0.0",
"renewal_fee": "0.0",
"endless": false,
"trial": false,
"public": true,
"status": "active",
"description": ""
}
},
{
"id": "804",
"type": "plans",
"attributes": {
"created_at": "2020-09-10T21:26:49.998+03:00",
"updated_at": "2019-11-02T02:50:34.038+03:00",
"status": "active",
"name": "CSP monthly",
"description": "",
"public": true,
"plan_class_id": 4,
"product_id": 400,
"billing_type": "csp_monthly",
"ancestry": null,
"reseller_id": 1,
"fixed_price": false,
"plan_class": "CSP monthly",
"product_category_id": 190,
"product_category": "default",
"product": "Default",
"plan_resources": {
"data": [
{
"id": "2849",
"type": "plan_resources",
"attributes": {
"created_at": "2018-03-05T05:06:03.235+03:00",
"updated_at": "2019-11-11T15:50:00.612+03:00",
"name": "r3",
"measurable": false,
"unit_of_measure": "unit",
"application_template_name": "auto prov new",
"included": 5,
"minimum": 5,
"limit": 0,
"setup_fee": "0.0",
"recurring_fee": "50.0",
"overuse_fee": "0.0",
"renewal_fee": "0.0",
"unlimited_units": true,
"public": true,
"status": "active",
"resource_id": 1427,
"custom_attributes": {
"item_1c_id": "",
"vendor_short_name": ""
}
}
}
]
},
"plan_periods": {
"data": [
{
"id": "1611",
"type": "plan_periods",
"attributes": {
"created_at": "2018-05-22T02:31:36.531+03:00",
"updated_at": "2018-05-22T02:31:36.531+03:00",
"duration_value": 1,
"duration_type": "month",
"setup_fee": "0.0",
"recurring_fee": "0.0",
"transfer_fee": "0.0",
"renewal_fee": "0.0",
"trial": true,
"public": true,
"status": "active",
"description": ""
}
},
{
"id": "1614",
"type": "plan_periods",
"attributes": {
"created_at": "2018-03-01T04:35:03.182+03:00",
"updated_at": "2018-03-01T04:35:03.182+03:00",
"duration_value": 1,
"duration_type": "year",
"setup_fee": "0.0",
"recurring_fee": "0.0",
"transfer_fee": "0.0",
"renewal_fee": "0.0",
"trial": false,
"public": true,
"status": "active",
"description": ""
}
}
]
},
"available_account_types": [
{
"id": 1564,
"name": "Физическое лицо",
"created_at": "2017-03-20T16:34:28.163+03:00",
"updated_at": "2020-05-05T13:01:02.962+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personal",
"default_payment_method_id": 2,
"ancestry": "1562",
"use_by_default": false
},
{
"id": 1602,
"name": "Юридическое лицо",
"created_at": "2017-03-21T10:48:13.152+03:00",
"updated_at": "2020-05-05T12:58:44.367+03:00",
"reseller_id": 1,
"name_pattern": "%primary_name",
"primary_name": "Company name",
"key": "business",
"default_payment_method_id": 1,
"ancestry": "1600",
"use_by_default": false
}
],
"plan_currency": "RUB",
"custom_attributes": {
"item_1c_id": ""
}
}
}
],
"links": {
"self": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?include=account%2Cplan%2Csubscription_period%2Csubscription_resources&meta=true&page%5Bnumber%5D=2610&page%5Bsize%5D=2",
"first": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?include=account%2Cplan%2Csubscription_period%2Csubscription_resources&meta=true&page%5Bnumber%5D=1&page%5Bsize%5D=2",
"prev": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?include=account%2Cplan%2Csubscription_period%2Csubscription_resources&meta=true&page%5Bnumber%5D=2609&page%5Bsize%5D=2",
"next": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?include=account%2Cplan%2Csubscription_period%2Csubscription_resources&meta=true&page%5Bnumber%5D=2611&page%5Bsize%5D=2",
"last": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?include=account%2Cplan%2Csubscription_period%2Csubscription_resources&meta=true&page%5Bnumber%5D=2617&page%5Bsize%5D=2"
}
}