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

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

GET {reseller_domain}/internal_api/accounts/{account_id}/payment_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	Число платежей в каждом статусе, кроме платежей в статусе Отменен. Если в каком-либо статусе нет ни одного платежа, соответствующий элемент объекта отсутствует
	pending_billing	integer	Число платежей в статусе Ожидание счета
	waiting_for_payment	integer	Число платежей в статусе Ожидает оплаты
	expired	integer	Число платежей в статусе Просрочен
	completed	integer	Число платежей в статусе Завершен
	paid_from_balance	integer	Число платежей в статусе Оплачен с баланса
	processing	integer	Число платежей в статусе Обрабатывается
	invoice_creation	integer	Число платежей в статусе Счет формируется
	invoice_sent	integer	Число платежей в статусе Счет отправлен
count		integer	Общее число платежей, кроме платежей в статусе Отменен
use_to_join		integer	Число платежей, доступных для объединения (см. Объединение платежей )
subscriptions_with_payments		array of objects	Список подписок, по которым есть хотя бы один платеж, кроме платежей в статусе Отменен
	id	integer	ID подписки
	name	string	Название подписки
	payment_ids	array	Список ID платежей, связанных с подпиской

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1741/payment_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": {
        "paid_from_balance": 1,
        "completed": 2
    },
    "count": 3,
    "use_to_join": 0,
    "subscriptions_with_payments": [
        {
            "id": 3010099,
            "name": "Office",
            "payment_ids": [
                11122,
                11121
            ]
        },
        {
            "id": 3009021,
            "name": "Office",
            "payment_ids": [
                10271
            ]
        }
    ]
}