Получение информации о подписке

Метод Get subscription позволяет получить информацию о подписке для текущего реселлера или любого из его нижестоящих реселлеров.

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

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}

Аргументы

Название

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

Тип данных

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

Описание

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 любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

subscription_id path integer Обязательный ID подписки

meta query bool Опциональный Запрос дополнительных атрибутов подписки

include

query

string

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

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

Объект	Значение параметра
Клиент, которому принадлежит подписка	`account`
Тарифный план	`plan`
Период, на который заказана подписка	`subscription_period`
Ресурсы подписки, доступные для заказа	`subscription_resources`

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

Название

Тип данных

Описание

data object Данные ответа

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

Является ли данная подписка пробной:

true — подписка является пробной.
false — подписка является коммерческой.

status

string

Статус подписки (список статусов см. в Просмотр списка подписок)

start_date string Дата активации подписки (ГГГГ-ММ-ДД)

expiration_date string Дата истечения срока действия подписки (ГГГГ-ММ-ДД)

plan_period_id integer ID периода тарифного плана

promo_code string Код, который был использован для получения скидки

payment_model

string

Модель оплаты подписки. Возможные значения:

prepay — Предоплата.
postpay — Постоплата.

payment_model_parameters object Параметры модели оплаты подписки

credit_limit number Величина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay

current_debt number Величина текущей задолженности по подписке. Возвращается только для payment_model = postpay

renewal_settings object Информация о параметрах продления подписки

autorenew

bool

Активирована ли опция Автопродление для подписки:

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

disable_autorenew

bool

Доступность для изменения опции Автопродление подписки:

true — опция Автопродление недоступна для изменения.
false — опция Автопродление доступна для изменения.

autorenew_point integer Точка автоматического продления (в днях)

manual_renew_point integer Точка ручного продления (в днях)

fixed_price

bool

Значение признака Фиксированная цена в заказанном тарифном плане (см. Общая информация о тарифном плане):

true — признак Фиксированная цена установлен.
false — признак Фиксированная цена не установлен.

ability object Список доступных действий над подпиской

stop

bool

Остановка подписки (см. Остановка подписки):

true — действие доступно.
false — действие недоступно.

activate

bool

Активация подписки (см. Активация подписки):

true — действие доступно.
false — действие недоступно.

destroy

bool

Удаление подписки (см. Удаление подписки):

true — действие доступно.
false — действие недоступно.

adjust

bool

Изменение количества ресурсов подписки (см. Создание заказа на изменение количества ресурсов):

true — действие доступно.
false — действие недоступно.

immediate_switch_plan_order

bool

Немедленное переключение тарифного плана подписки (см. Создание заказа на переключение):

true — действие доступно.
false — действие недоступно.

delayed_switch_plan_order bool Отложенное переключение тарифного плана подписки (см. Создание заказа на переключение):

renew

bool

Продление подписки вручную (см. Создание заказа на продление):

true — действие доступно.
false — действие недоступно.

change_auto_renew_option

bool

Изменение опции Автопродление подписки (см. Обновление подписки):

true — действие доступно.
false — действие недоступно.

prolong

bool

Пролонгация подписки вручную (см. Создание заказа на пролонгацию):

true — действие доступно.
false — действие недоступно.

change_resources_renewal_order

bool

Изменение количества ресурсов подписки в заказе на продление (см. Отложенное продление подписки в ActivePlatform. Панель управления Оператора):

true — действие доступно.
false — действие недоступно.

decrease_resources_change_order

bool

Уменьшение количества ресурсов подписки в заказе на изменение количества ресурсов (см. Изменение количества ресурсов подписки в ActivePlatform. Панель управления Оператора):

true — действие доступно.
false — действие недоступно.
Например, уменьшение количества ресурсов подписки может быть недоступно, так как для подписки были вручную закрыты списания (Ручное закрытие всех списаний по подписке в ActivePlatform. Панель управления Оператора). В этом случае действие недоступно до даты, указанной в параметре hold_to метода API v1 Получение информации о Подписке по ID.

decrease_resources_prolong_order

bool

Уменьшение количества ресурсов подписки в заказе на пролонгацию (см. Пролонгация подписки в ActivePlatform. Панель управления Оператора):

true — действие доступно.
false — действие недоступно.

custom_price

bool

Признак индивидуальной цены (см. Заказ на покупку подписки в ActivePlatform. Панель управления Оператора):

true — подписка заказана по индивидуальным ценам (с индивидуальной наценкой).
false — подписка заказана по ценам, указанным в тарифном плане.

relationships object Перечень объектов, связанных с подпиской

account object Информация о связанном клиенте

data

object

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

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

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

data

array

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

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

subscription_period object Информация о периоде, на который заказана подписка

data

object

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

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

plan object Информация о тарифном плане подписки

data

object

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

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

meta object Дополнительные атрибуты подписки (см. Просмотр информации об экземпляре услуги в разделе Подписки в Просмотр информации об экземпляре услуги)

applications array Перечень дополнительных атрибутов подписки. Зависит от конкретной подписки

'attribute.name' string Значение атрибута

included

array

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

Для клиента: см. Получение информации о клиенте.
Для тарифного плана: см. Получение информации о тарифном плане.
Для ресурсов подписки:

Название			Тип данных	Описание
id			string	ID ресурса в подписке
type			string	Тип данных
attributes			object	Информация о ресурсах тарифного плана (см. Ресурсы тарифного плана)
	created_at		string	Дата и время создания ресурса
	updated_at		string	Дата и время последнего обновления ресурса
	name		string	Название ресурса
	measurable		bool	Признак использования модели расчета стоимости за фактическое использование ресурса (недоступен, если функция не поддерживается внешними службами): true — используется расчет за фактическое использование ресурса. false — не используется расчет за фактическое использование ресурса.
	unit_of_measure		string	Единица измерения ресурса: unit — измеряемый ресурс, для которого указывается определенное количество. boolean — неизмеряемый ресурс (для ресурсов, у которых не надо указывать количество), возможные значения: true — ресурс включен в тарифный план. false — ресурс не включен в тарифный план.
	application_template_name		string	Название услуги, которая предоставляется в рамках данного тарифного плана
	included		integer	Количество ресурса, которое включено в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)
	minimum		integer	Минимальное количество ресурса (с учетом величины included), которое доступно для заказа
	limit		integer	Максимальное количество ресурса, доступное для заказа. Если ресурс безлимитный (признак `unlimited_units=true`), то `limit = 0`
	additional		integer	Количество ресурса, которое заказано дополнительно
	priority		integer	Приоритет ресурса в тарифном плане
	setup_fee		string	Величина платежа за установку ресурса
	recurring_fee		string	Величина ежемесячной абонентской платы за ресурс
	overuse_fee		string	Стоимость перерасхода ресурсов
	renewal_fee		string	Стоимость продления использования ресурса
	unlimited_units		bool	Признак отключения лимитов использования ресурса: true — лимиты отключены. false — лимиты активны.
	public		bool	Возможные значения: true — ресурс доступен клиентам для заказа. false — ресурс недоступен клиентам для заказа.
	status		string	Статус ресурса: active — активный. inactive — неактивный. deleted — удален.
	resource_id		integer	ID ресурса тарифного плана
	custom_attributes		array of objects	Информация о дополнительных параметрах ресурса
		'custom-attribute-key'	string	Значение дополнительного параметра ресурса

Для периода, на который заказана подписка:

Название		Тип данных	Описание
id		string	ID периода тарифного плана
type		string	Тип данных
attributes		object	Информация о периодах тарифного плана
	created_at	string	Дата и время создания периода тарифного плана
	updated_at	string	Дата и время последнего обновления периода тарифного плана
	duration_value	integer	Длительность периода тарифного плана
	duration_type	string	Единица измерения периода тарифного плана
	setup_fee	string	Стоимость установки тарифного плана для данного периода
	recurring_fee	string	Ежемесячная стоимость тарифного плана для данного периода
	transfer_fee	string	Стоимость переноса домена, если услуги включает в себя возможность использования доменов
	renewal_fee	string	Стоимость продления тарифного плана для данного периода
	endless	bool	Признак того, является ли период тарифного плана бессрочным: true — период является бессрочным. false — период не является бессрочным.
	trial	bool	Признак того, является ли период тарифного плана пробным: true — период является пробным. false — период не является пробным.
	public	bool	Признак доступности периода для заказа в рамках данного тарифного плана: true — период доступен для заказа. false — период недоступен для заказа.
	status	string	Статус периода тарифного плана: active — активный. deleted — удален.
	description	string	Описание периода тарифного плана

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

GET /api/v3/resellers/1/subscriptions/3007095?meta=true&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"
                }
            ]
        }
    },
    "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": "+15555554108",
                "email": "test@example.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@exampel.com",
                    "account_status": "active",
                    "global_status": "active",
                    "first_name": "Tann",
                    "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": ""
                }
            }
        }
    ]
}