Получение списка Подписок всех нижестоящих Реселлеров

Метод Get a List of the Child Reseller's Subscriptions используется для получения списка Подписок, существующих у всех Реселлеров, являющихся нижестоящими по отношению к текущему Реселлеру, или по отношению к его выбранному нижестоящему Реселлеру.

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

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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	Опциональный	Параметр постраничной навигации. Номер страницы ответа
meta	query	bool	Опциональный	Запрос дополнительных атрибутов Подписки. Применимо к Подпискам на основе модулей Vendor Service и Office365

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

Название				Тип данных	Описание
data				array	Данные ответа
	id			integer	ID Подписки
	type			string	Тип данных
	attributes			object	Информация о Подписке
		created_at		date	Дата и время создания Подписки
		updated_at		date	Дата и время последнего изменения Подписки
		plan_id		integer	ID Тарифного плана Подписки
		account_id		integer	ID Клиента, которому принадлежит Подписка
		name		string	Название Подписки
		trial		bool	Является ли данная Подписка пробной: true – Подписка является пробной; false – Подписка является коммерческой.
		status		string	Статус Подписки (список статусов см. в Просмотр списка подписок)
		start_date		date	Дата активации Подписки
		expiration_date		date	Дата истечения срока действия Подписки
		plan_period_id		integer	ID периода Тарифного плана
		promo_code		string	Код, который был использован для получения скидки
		payment_model		string	Модель оплаты Подписки. Возможные значения: prepay – Предоплата postpay – Постоплата
		payment_model_parameters		object	Параметры модели оплаты Подписки
			credit_limit	float	Величина кредитного лимита, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента или Подписки. Возвращается только для payment_model = postpay
			current_debt	float	Величина текущей задолженности по Подписке. Возвращается только для payment_model = postpay
	meta			object	Дополнительные атрибуты Подписки
		applications		array	Перечень дополнительных атрибутов Подписки. Зависит от конкретной Подписки
			'attribute.name'	string	Значение атрибута
links				object	Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации
	self			string	Ссылка на текущую страницу
	first			string	Ссылка на первую страницу
	prev			string	Ссылка на предыдущую страницу
	next			string	Ссылка на следующую страницу
	last			string	Ссылка на последнюю страницу

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

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

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

{
    "data": [
        {
            "id": "850",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2017-01-30T14:33:06.685+03:00",
                "updated_at": "2018-02-07T01:05:21.928+03:00",
                "plan_id": 75,
                "account_id": 77,
                "name": "Office 365 Enterprise E1",
                "trial": false,
                "status": "waiting_for_manual_approve",
                "start_date": "2017-01-30",
                "expiration_date": "2018-01-30",
                "plan_period_id": 407,
                "promo_code": null,
                "payment_model": "postpay",
                "payment_model_parameters": {
                    "credit_limit": 1000.0,
                    "current_debt": 24.0
                }
            },
            "meta": {
                "applications": [
                    {
                        "plugin_name": "Office365 Plugin",
                        "tenant_id": "5a13b59e-test-test-test-05364ae96da9",
                        "tenant_name": "example.onmicrosoft.com",
                        "order_id": "b73bf9b8-test-test-test-0ae7e73a4d6b",
                        "external_id": "82628CF7-test-test-test-A573E2378267"
                    }
                ]
            }
        },
        {
            "id": "851",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2017-01-30T14:33:10.089+03:00",
                "updated_at": "2017-01-31T01:02:02.975+03:00",
                "plan_id": 75,
                "account_id": 77,
                "name": "Auto provisioning with resources",
                "trial": false,
                "status": "deleted",
                "start_date": null,
                "expiration_date": null,
                "plan_period_id": 407,
                "promo_code": null,
                "payment_model": "prepay",
                "payment_model_parameters": {}
            },
            "meta": {
                "applications": []
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?meta=true&page%5Bnumber%5D=2&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?meta=true&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?meta=true&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?meta=true&page%5Bnumber%5D=3&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/subscriptions?meta=true&page%5Bnumber%5D=1801&page%5Bsize%5D=2"
    }
}