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

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

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

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого запрашивается список подписок
filter[status]	query	string	Опциональный	Предназначен для фильтрации списка по статусу подписки. Можно указать несколько значений через запятую. Доступные значения: ordered — Новый заказ. active — Активная. delivered — Доставлена. graced — Просрочена оплата. stopped — Остановлена. deleted — Удалена. installation_failed — Ошибка установки. activation_failed — Ошибка активации. renewal_failed — Ошибка продления. updating_failed — Ошибка обновления. stopping_failed — Остановка не может быть завершена. deletion_failed — Ошибка удаления. switching_failed — Ошибка переключения. installing — Установка. activating — Активируется. renewing — Продление. updating — Обновление. stopping — Останавливается. deleting — Удаляется. switching — Переключение. waiting_for_manual_approve — Ожидает ручного подтверждения. blocked — Заблокирована.
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID подписки
	type		string	Тип данных
	attributes		object	Информация о подписке
		name	string	Название подписки
		created_at	string	Дата и время создания подписки
		status	string	Статус подписки
		billing_type	string	Тип биллинга тарифного плана, на который заказана подписка
		payment_model	string	Модель оплаты подписки: prepay — Предоплата. postpay — Постоплата.
meta			object	Дополнительная информация
	server_current_time		string	Текущие дата и время сервера

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

Bash

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

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

JSON

{
    "data": [
        {
            "id": "12",
            "type": "subscriptions",
            "attributes": {
                "name": "999 Google Cloud",
                "created_at": "2022-12-26T12:39:48.613Z",
                "status": "ative",
                "billing_type": "pay_as_you_go_external",
                "payment_model": "prepay"
            }
        },
        {
            "id": "66",
            "type": "subscriptions",
            "attributes": {
                "name": "Office Monthly",
                "created_at": "2023-01-18T06:56:23.094Z",
                "status": "blocked",
                "billing_type": "csp_monthly",
                "payment_model": "postpay"
            }
        }
    ],
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}