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

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

GET {reseller_domain}/internal_api/accounts/{account_id}/subscription_statistics

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается статистика подписок

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

Название		Тип данных	Описание
count_by_statuses		object	Число подписок в каждом статусе, кроме подписок в статусах Удалена и Ошибка удаления. Если в каком-либо статусе нет ни одной подписки, соответствующий элемент объекта отсутствует
	ordered	integer	Число подписок в статусе Новый заказ
	active	integer	Число подписок в статусе Активная
	delivered	integer	Число подписок в статусе Доставлена
	graced	integer	Число подписок в статусе Просрочена оплата
	stopped	integer	Число подписок в статусе Остановлена
	installation_failed	integer	Число подписок в статусе Ошибка установки
	activation_failed	integer	Число подписок в статусе Ошибка активации
	renewal_failed	integer	Число подписок в статусе Ошибка продления
	updating_failed	integer	Число подписок в статусе Ошибка обновления
	stopping_failed	integer	Число подписок в статусе Остановка не может быть завершена
	switching_failed	integer	Число подписок в статусе Ошибка переключения
	installing	integer	Число подписок в статусе Установка
	activating	integer	Число подписок в статусе Активируется
	renewing	integer	Число подписок в статусе Продление
	updating	integer	Число подписок в статусе Обновление
	stopping	integer	Число подписок в статусе Останавливается
	deleting	integer	Число подписок в статусе Удаляется
	switching	integer	Число подписок в статусе Переключение
	waiting_for_manual_approve	integer	Число подписок в статусе Ожидает ручного подтверждения
	blocked	integer	Число подписок в статусе Заблокирована
count_by_payment_model		object	Число подписок по каждой модели оплаты, кроме подписок в статусах Удалена и Ошибка удаления. Если по какой-либо модели оплаты нет ни одной подписки, соответствующий элемент объекта отсутствует
	prepay	integer	Число подписок по модели Предоплата
	postpay	integer	Число подписок по модели Постоплата
count		integer	Общее число подписок, кроме подписок в статусах Удалена и Ошибка удаления

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1741/subscription_statistics' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "count_by_statuses": {
        "active": 14,
        "stopping_failed": 3,
        "deleting": 14,
        "updating_failed": 1,
        "stopped": 32,
        "waiting_for_manual_approve": 19,
        "graced": 6,
        "installation_failed": 2,
        "delivered": 1
    },
    "count_by_payment_model": {
        "prepay": 87,
        "postpay": 5
    },
    "count": 92
}