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

Метод Get List of Subscriptions позволяет получить список всех созданных Подписок.

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см.Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)
page	query	integer	Опциональный	Возвращается список подписок по указанному номеру страницы
per_page	query	integer	Опциональный	Установка числа элементов на странице
sorting[field]	query	string	Опциональный	Сортировка списка по указанному полю
sorting[reversed]	query	string	Опциональный	Установка режима обратной сортировки по указанному полю: true — список будет отсортирован по убыванию. false — список будет отсортирован по возрастанию (используется по умолчанию).
filters[created_at]	query	date	Опциональный	Фильтрация списка по дате создания
filters[updated_at]	query	date	Опциональный	Фильтрация списка по дате обновления
filters[status]	query	string	Опциональный	Фильтрация списка по статусу
filters[account_id]	query	integer	Опциональный	Фильтрация списка по ID аккаунта
filters[plan_id]	query	integer	Опциональный	Фильтрация списка по ID тарифного плана

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

Название		Тип данных	Описание
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		object	Параметры модели оплаты Подписки
	credit_limit	float	Величина Кредитного лимита по подписке, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента или Подписки. Возвращается только для payment_model = postpay
	current_debt	float	Величина Текущей задолженности по Подписке. Возвращается только для payment_model = postpay

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

GET /api/vendor/v1/subscriptions?api_token=vY5fwetestK3gJXZH5uHCw&per_page=2&page=5&sorting[field]=plan_id&sorting[reversed]=true

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

 [
    {
        "id": 3005382,
        "plan_id": 1438,
        "account_id": 275,
        "name": "ESET NOD32(LOCAL SERVICE)",
        "trial": false,
        "status": "installation_failed",
        "start_date": null,
        "expiration_date": "2119-09-17",
        "plan_period_id": 2599,
        "promo_code": null,
        "created_at": "2019-06-04T10:53:45.651+03:00",
        "updated_at": "2019-06-04T11:06:25.397+03:00",
        "hold_to": null,
        "payment_model": "prepay",
        "payment_model_parameters": {}
    },
    {
        "id": 3005362,
        "plan_id": 1437,
        "account_id": 411,
        "name": " ESET NOD32 Mobile Security",
        "trial": false,
        "status": "deleted",
        "start_date": "2019-12-15",
        "expiration_date": "2020-12-15",
        "plan_period_id": 2597,
        "promo_code": null,
        "created_at": "2019-12-15T10:11:56.599+03:00",
        "updated_at": "2019-05-31T11:05:41.402+03:00",
        "hold_to": null,
        "payment_model": "postpay",
        "payment_model_parameters": {
            "credit_limit": 25.0,
            "current_debt": 0.0
        }
    }
]