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

Метод используется для получения одностраничного списка записей о выявленных пиках потребления по указанной подписке с оплатой по мере потребления (pay-as-you-go, PAYG) аккаунта, к которому есть доступ у текущего пользователя, включая подписки в статусе Удалена, Ошибка удаления. Метод возвращает список пиков, выявленных только за последний год, начиная с текущей даты. Настройки выявления пиков потребления см. в , а алгоритм поиска пиков см. в описании события Обнаружение неожиданного увеличения потребления (Unexpected consumption increase detection) в .

GET {reseller_domain}/internal_api/accounts/{account_id}/subscriptions/{subscription_id}/consumption_peaks

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, которому принадлежит подписка
subscription_id	path	integer	Обязательный	ID подписки
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`. sort=operate_day — сортировка по возрастанию значений `operate_day`. sort=-operate_day — сортировка по убыванию значений `operate_day`.

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

Название			Тип данных	Описание
data			array of objects	Список пиков потребления
	id		string	ID пика потребления
	type		string	Тип данных
	attributes		object	Информация о пике потребления
		created_at	string	Дата и время создания записи о пике потребления
		operate_day	string	Дата и время потребления
		amount_with_currency	string	Сумма потребления с указанием валюты реселлера
		amount	number	Сумма потребления
		reseller_currency_iso_code	string	Код валюты реселлера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1451/subscriptions/3008635/consumption_peaks' \
--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": "3",
            "type": "consumption_peaks",
            "attributes": {
                "created_at": "2023-01-16T16:59:37.793103+0300",
                "operate_day": "2023-01-16T00:00:00.000000+0000",
                "amount_with_currency": "$400.00",
                "amount": 400.0,
                "reseller_currency_iso_code": "USD"
            }
        }
    ]
}