Получение информации о Подписке нижестоящего Реселлера

Метод Get the Child Reseller's Subscription by ID позволяет получить информацию о Подписке по ID данной Подписки нижестоящего Реселлера по отношению к текущему Реселлеру.

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

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

Аргументы

Название

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

Тип данных

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

Описание

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

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

Название

Тип данных

Описание

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


id

integerID Подписки

typestringТип данных

attributesobjectИнформация о Подписке


created_at

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


updated_at

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


plan_idintegerID Тарифного плана Подписки


account_idintegerID Клиента, которому принадлежит Подписка


namestringНазвание Подписки


trialbool

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

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


statusstring

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



start_datedateДата активации Подписки


expiration_datedateДата истечения срока действия Подписки


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


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


payment_modelstring

Subscription payment model:

  • prepay
  • postpay


payment_model_parametersobjectPayment model parameters



credit_limitfloatThe value of the Subscription debt, above which the postpaid Subscription will be stopped. For postpaid Subscription only (payment_model = postpay)



current_debtfloatThe Subscription debt that is calculated as the total amount of all blocked Charges for the Subscription for the current Billing period. For postpaid Subscription only (payment_model = postpay)

metaobjectДополнительные атрибуты Подписки


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

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

GET /api/v3/resellers/1/child_reseller_subscriptions/3005076?meta=true
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "3005076",
        "type": "subscriptions",
        "attributes": {
            "created_at": "2019-04-02T11:31:07.062+03:00",
            "updated_at": "2019-08-22T11:38:04.251+03:00",
            "plan_id": 1392,
            "account_id": 452,
            "name": "Microsoft Azure",
            "trial": false,
            "status": "active",
            "start_date": "2019-02-21",
            "expiration_date": "2119-08-23",
            "plan_period_id": 2478,
            "promo_code": "",
            "payment_model": "postpay",
            "payment_model_parameters": {
                "credit_limit": 1000.0,
                "current_debt": 24.0
            }
        },
        "meta": {
            "applications": [
                {
                    "plugin_name": "Office365 Plugin",
                    "tenant_id": "12c459a9-test-test-test-ba5ea90a2018",
                    "tenant_name": "example.onmicrosoft.com",
                    "order_id": "1063EA8D-test-test-test-4C5C6BCD515D",
                    "external_id": "1025E799-test-test-test-15C07F27EFDB"
                }
            ]
        }
    }
}