Получение списка Подписок Клиента

Метод Get Account’s Subscriptions by ID возвращает список Подписок для Клиента, используя ID клиента.

GET /api/vendor/v1/accounts/{id}/subscriptions.json?api_token={api_token}

Аргументы

Название	Тип параметров	Тип данных	Обязательный/Опциональный	Описание
id	path	integer	Обязательный	ID Клиента
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

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

Название		Тип данных	Описание
id		integer	ID Подписки
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	Код, который был использован для получения скидки
created_at		date	Дата и время создания Подписки
updated_at		date	Дата и время последнего изменения Подписки
hold_to		date	Дата, до которой по Подписке не требуется выполнять биллинг процесс, так как все списания по Подписке были закрыты (см. Ручное закрытие всех списаний по подписке)
payment_model		string	Модель оплаты Подписки. Возможные значения: prepay – Предоплата postpay – Постоплата
payment_model_parameters		array	Параметры модели оплаты Подписки
	credit_limit	string	Величина Кредитного лимита по подписке, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента или Подписки. Возвращается только для payment_model = postpay
	current_debt	string	Величина Текущей задолженности по Подписке. Возвращается только для payment_model = postpay

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

GET /api/vendor/v1/accounts/431/subscriptions.json?api_token=vY5fwetestK3gJXZH5uHCw

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

[
    {
        "id": 3005515,
        "plan_id": 17,
        "account_id": 431,
        "name": "Manual Provisioning (all)",
        "trial": false,
        "status": "deleted",
        "start_date": null,
        "expiration_date": null,
        "plan_period_id": 68,
        "promo_code": null,
        "created_at": "2019-06-27T15:33:46.111+03:00",
        "updated_at": "2019-06-27T15:33:46.111+03:00",
        "hold_to": null,
        "payment_model": "prepay",
        "payment_model_parameters": {}
    },
    {
        "id": 3005513,
        "plan_id": 5,
        "account_id": 431,
        "name": "Auto provisioning with resources",
        "trial": false,
        "status": "stopped",
        "start_date": "2019-06-27",
        "expiration_date": "2020-06-30",
        "plan_period_id": 6,
        "promo_code": null,
        "created_at": "2019-06-27T15:28:00.932+03:00",
        "updated_at": "2019-09-05T00:03:55.165+03:00",
        "hold_to": null,
        "payment_model": "postpay",
        "payment_model_parameters": {
            "credit_limit": 1000.0,
            "current_debt": 24.0
        }
    }
]