Получение ссылки для скачивания отчета по подпискам

Метод используется для получения ссылки для скачивания отчета по подпискам, кроме подписок в статусах Удалена и Ошибка удаления, для аккаунта, к которому есть доступ у текущего пользователя:

Отчет содержит список подписок с учетом заданных фильтров, отсортированный по ID подписок.
Состав отчета
- ID подписки
- Название подписки
- План
- SKU
- Пробный — Да/Нет
- Статус
- Модель оплаты
- Дата активации (ДД.ММ.ГГГГ)
- Дата истечения (ДД.ММ.ГГГГ или Бессрочный)
- Оплачена до (ДД.ММ.ГГГГ)
- Автопродление — Да/Нет
- Основной ресурс
- Количество основного ресурса
- Текущая стоимость основного ресурса, ед./мес
- Валюта плана
Имя файла отчета формируется по шаблону: Subscriptions_<ID аккаунта>_<текущая дата ГГГГ-ММ-ДД>.
Формат файла отчета — .XLSX.

GET {reseller_domain}/internal_api/accounts/{account_id}/subscriptions/export

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого запрашивается список подписок
format	query	string	Обязательный	Формат файла отчета. Укажите xlsx
filter[full_name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части ID и названия подписки
filter[status]	query	string	Опциональный	Предназначен для фильтрации списка по статусу подписки. Можно указать несколько значений через запятую. Доступные значения: ordered — Новый заказ. active — Активная. delivered — Доставлена. graced — Просрочена оплата. stopped — Остановлена. installation_failed — Ошибка установки. activation_failed — Ошибка активации. renewal_failed — Ошибка продления. updating_failed — Ошибка обновления. stopping_failed — Остановка не может быть завершена. switching_failed — Ошибка переключения. installing — Установка. activating — Активируется. renewing — Продление. updating — Обновление. stopping — Останавливается. deleting — Удаляется. switching — Переключение. waiting_for_manual_approve — Ожидает ручного подтверждения. blocked — Заблокирована.
filter[payment_model]	query	string	Опциональный	Предназначен для фильтрации списка по модели оплаты подписки. Можно указать несколько значений через запятую. Доступные значения: prepay — Предоплата. postpay — Постоплата.
filter[expiration_date]	query	string	Опциональный	Предназначен для фильтрации списка по дате истечения подписки в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры: filter[expiration_date][gt] — дата больше, чем указанная. filter[expiration_date][lt] — дата меньше, чем указанная. filter[expiration_date][gteq] — дата больше, чем указанная, или равна. filter[expiration_date][lteq] — дата меньше, чем указанная, или равна.

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

Название		Тип данных	Описание
data		object	Данные ответа
	url_for_download	string	Ссылка для скачивания отчета
meta		object	Дополнительная информация
	server_current_time	string	Текущие дата и время сервера

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

Bash

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

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

JSON

{
    "data": {
            "url_for_download": "https://test.activeplatform.com/private/Subscriptions_1234_20230630.xsls?expires=1683372277&hash=R80QFP&filename=Subscriptions_1234_20230630.xsls"
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}