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

Метод Get list of charges используется для получения списка списаний для текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/charges

Аргументы

Название

Тип параметра

Тип данных

Обязательный/
Опциональный

Описание

X-Api-Token header string Обязательный API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)

Content-Type header string Обязательный Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json

Accept header string Обязательный Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json

base_url path string Обязательный URL ActivePlatform

reseller_id path integer Обязательный ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

page[size] query integer Опциональный Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number] query integer Опциональный Параметр постраничной навигации. Номер страницы ответа

filter[close_date]

query

string

Опциональный

Предназначен для фильтрации списаний по дате закрытия в формате ГГГГ-ММ-ДД. Для указания диапазона дат используются следующие фильтры:

filter[close_date][gt] — дата закрытия более, чем указанная дата.
filter[close_date][lt] — дата закрытия менее, чем указанная дата.

filter[subscription_id]

query

integer

Опциональный

Фильтрация списка по ID подписки

filter[status]

query

string

Опциональный

Фильтрация списка по статусу списания (список статусов см. в Атрибуты списаний)

filter[created_at]

query

string

Опциональный

Предназначен для фильтрации списаний по дате и времени создания в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:

filter[created_at][gt] — дата и время более, чем указанные.
filter[created_at][lt] — дата и время менее, чем указанные.

filter[updated_at]

query

string

Опциональный

Предназначен для фильтрации списаний по дате дате и времени последнего обновления в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:

filter[updated_at][gt] — дата и время более, чем указанные.
filter[updated_at][lt] — дата и время менее, чем указанные.

filter[plan_class_ids]

query

string

Опциональный

Предназначен для фильтрации списаний по ID правила предоставления (см. Просмотр списка правил предоставления). Поддерживается указание списка из нескольких ID правил предоставления, разделенных запятыми

filter[billing_date] query string Опциональный Предназначен для фильтрации закрытых списаний по дате начала финансового периода в формате ГГГГ-ММ-ДД, к которому они относятся

include

query

string

Опциональный

Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:

Объект	Значение параметра
Реселлер	`reseller`
Клиент	`account`
Подписка	`subscription`
Тарифный план	`plan`
Налоги	`taxes`
Заказ (кроме PAYG-подписок)	`order`
Скидка типа Реселлер	`reseller_discount`

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

Название

Тип данных

Описание

data array Данные ответа

id

string

ID списания

type string Тип данных

attributes object Информация о списании

created_at string Дата и время создания списания

updated_at string Дата и время последнего изменения списания

subscription_id integer ID подписки

subscription_resource_id integer ID ресурса в клиентской подписке

operate_from

string

Дата начала периода, оплаченного списанием, в формате ГГГГ-ММ-ДД

description string Подробное описание списания

unit_price string Цена продажи единицы ресурса или услуги в валюте тарифного плана

amount string Сумма списания в валюте реселлера с налогами

status string Статус списания (список статусов см. в Атрибуты списаний)

type

string

Тип списания (см. также Атрибуты списаний):

Charge::Setup — списание за установку подписки.
Charge::Recurring — списание за абонентскую плату подписки.
Charge::RecurringResource — списание за абонентскую плату ресурса подписки.
Charge::Renewal — списание за продление подписки.
Charge::RenewalResource — списание за продление ресурса.
Charge::ExternalResource — списание за использование внешнего ресурса.
Charge::SetupResource — списание за установку ресурсов подписки.
Charge::Transfer — списание за перенос домена.

net_cost

string

Себестоимость списания в валюте реселлера, рассчитанная по формуле:

net_cost = cost × duration × quantity × net_cost_currency_rate / net_cost_currency_unit

где cost — себестоимость периода или ресурса, заданная в тарифном плане для соответствующего типа списания с учетом скидки типа Реселлер (при наличии)

tax_is_calculated_using

string

Значение параметра Налоги рассчитываются в системных настройках на момент создания списания (см. Настройки расчета налогов):

net_prices — Сверх цены плана — цены в тарифном плане указаны без налогов.
gross_prices — Внутри цены плана — цены в тарифном плане включают в себя налоги.

net_amount string Сумма списания в валюте реселлера без налогов

taxes_amount string Сумма всех налогов в валюте реселлера для списания

net_cost_original

string

Cебестоимость списания в валюте тарифного плана:

net_cost_original = cost × duration × quantity

где cost — себестоимость периода или ресурса, заданная в тарифном плане для соответствующего типа списания с учетом скидки типа Реселлер (при наличии)

net_cost_currency_rate

string

Курс валюты реселлера к валюте тарифного плана, использованный при расчете себестоимости списания

net_cost_currency_unit

integer

Номинал валюты, использованный при расчете себестоимости списания с учетом курса

unit_price_currency string Код валюты тарифного плана, в котором хранится информация о стоимости

quantity number Количество заказанных единиц услуги или ресурса

duration number Период списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24

subscription_resource_name string Имя ресурса в подписке, которая была заказана клиентом

plan_resource_id integer ID ресурса в тарифном плане, который был заказан клиентом

resource_id integer ID ресурса в шаблоне услуги

order_id integer ID заказа, по которому произведено списание

operate_to string Дата окончания периода, оплаченного списанием, в формате ГГГГ-ММ-ДД

close_date

string

Дата, когда списание должно быть закрыто, в формате ГГГГ-ММ-ДД

billing_date string Дата начала финансового периода, к которому относится закрытое списание, в формате ГГГГ-ММ-ДД

application_template_key string Ключ шаблона услуги, на основе которого создано приложение для подписки (см. Просмотр и обновление информации о коннекторе)

additional_params

array of objects

Дополнительные параметры списания для услуг на основе следующих модулей:

MicrosoftCspProducts:

Название	Тип данных	Описание
tenant_id	string	ID тенанта в Microsoft Partner Center
tenant_name	string	Имя тенанта (домен) в Microsoft Partner Center
ms_subscription_id	string	ID подписки на стороне Microsoft (внешний ID)
order_id	string	ID заказа на стороне Microsoft
alternate_id	string	Альтернативный ID заказа на стороне Microsoft
product_id	string	ID продукта на стороне Microsoft, к которому относится ресурс, связанный со списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
sku_id	string	SKU ресурса на стороне Microsoft, связанного со списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
term_duration	string	Term Duration подписки на стороне Microsoft. Например, P1M или P1Y
billing_cycle	string	Billing Cycle подписки на стороне Microsoft. Например, Monthly или Annual
attribute_type	string	Информация о назначении списания для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan): azure_plan — списание сформировано для основного потребления по подписке Microsoft Azure Plan. azure_ri — списание сформировано для зарезервированных ресурсов (Azure RI). 3rd_party — списание сформировано для сторонних ресурсов (third-party). azure_savings — списание сформировано для услуги Azure Savings Plan.
effective_cost	number	Себестоимость списания для реселлера с учетом скидки PEC от Microsoft. Только для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan)
azure_plan_id	string	ID "контейнера" Azure Plan на стороне Microsoft, в рамках которого создаются подписки клиента. Только для подписок на услугу Microsoft Azure Plan (см. Заказ подписки на услугу Microsoft Azure Plan через Панель управления Оператора)

Manual Provisioning Plugin (Ручной Провижининг):

Название	Тип данных	Описание
tenant_name	string	Основное имя клиента, заказавшего подписку (см. Получение информации о клиенте)
tenant_id	string	ID клиента, заказавшего подписку
order_id	string	ID заказа на покупку, связанного с подпиской
subscription_id	string	ID подписки
offer_id	string	SKU тарифного плана, на основе которого создана подписка (см. Получение информации о тарифном плане)

Office365:

Название	Тип данных	Описание
tenant_name	string	Имя тенанта (домен) в Microsoft Partner Center
tenant_id	string	Идентификатор тенанта в Microsoft Partner Center
order_id	string	Номер заказа на стороне Microsoft
subscription_id	string	ID подписки на стороне Microsoft
offer_id	string	Уникальный идентификатор (SKU) плана или дополнения в Microsoft Partner Center

Vendor Service Plugin (VSP):

Название	Тип данных	Описание
external_id	string	Application External ID (внешний ID)
plan_sku	string	Plan SKU
subscription_attributes	object	Дополнительные атрибуты подписки, созданные в Vendor Portal, кроме атрибута, содержащего пароль
resource_key	string	Application Resource Key
attribute_type	string	Информация о назначении списания: google_cloud — финальное списание по подписке Google Cloud Platform (см. Формирование записей о потребленных ресурсах для подписки на Услугу Google Cloud Platform). В остальных случаях параметр отсутствует.
effective_cost	number	Себестоимость финального списания для реселлера. Только для подписок Google Cloud Platform (см. Формирование записей о потребленных ресурсах для подписки на Услугу Google Cloud Platform). В остальных случаях параметр отсутствует

В остальных случаях возвращается пустой массив

discount string Размер скидки для данного списания в валюте реселлера

original_amount string Сумма списания в валюте тарифного плана

original_amount_currency string Код валюты тарифного плана для расчета суммы списания

currency_rate string Курс валюты реселлера к валюте тарифного плана, использованный при расчете суммы списания

currency_unit integer Номинал валюты, использованный при расчете суммы списания с учетом курса

net_cost_original_currency string Код валюты тарифного плана для расчета себестоимости списания

relationships

object

Перечень объектов, связанных со списанием

При переключении тарифного плана старые списания по подписке и новые списания за возврат средств остаются связаны со старым тарифным планом и его ресурсами. Все остальные новые списания будут связаны с новым тарифным планом и его ресурсами.

taxes object Информация о налогах

data

array of objects

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

reseller object Информация о реселлере

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

account object Информация о клиенте

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

subscription object Информация о подписке

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

plan

object

Информация о тарифном плане

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

plan_resource

object

Информация о ресурсе тарифного плана

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

discount object Информация о скидке

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

reseller_discount

object

Информация о скидке типа Реселлер

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

order

object

Информация о заказе

data

object

Информация о связанном объекте:

Название		Тип данных	Описание
id		string	ID объекта
type		string	Тип данных

included

array

Дополнительная информация о связанных объектах, указанных в запросе:

Название	Тип данных	Описание
id	string	ID объекта
type	string	Тип данных
attributes	object	Атрибуты (см. ниже)

Для реселлера состав данных см. в Получение информации о реселлере.
Для клиента состав данных см. в Получение информации о клиенте.
Для тарифного плана состав данных см. в Получение информации о тарифном плане.
Для заказа состав данных см. в Получение информации о заказе.
Для подписки:

Название			Тип данных	Описание
id			string	ID подписки
type			string	Тип данных
attributes			object	Информация о подписке
	created_at		string	Дата и время создания подписки
	updated_at		string	Дата и время последнего изменения подписки
	auto_renewal		bool	Признак автоматического продления подписки: true — автоматическое продление включено. false — автоматическое продление отключено.
	billing_from		string	Дата начала генерации списаний по подписке в формате ГГГГ-ММ-ДД
	expiration_date		string	Дата истечения срока действия подписки в формате ГГГГ-ММ-ДД
	name		string	Название подписки
	auto_renew_point_days		integer	Точка автоматического продления подписки (в днях)
	start_date		string	Дата активации подписки в формате ГГГГ-ММ-ДД
	status		string	Статус подписки (список статусов см. в Просмотр списка подписок)
	payment_model		string	Модель оплаты подписки. Возможные значения: prepay — Предоплата. postpay — Постоплата.
	payment_model_parameters		object	Параметры модели оплаты подписки
		credit_limit	number	Величина кредитного лимита, заданная на уровне Правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для `payment_model = postpay`
		current_debt	number	Величина текущей задолженности по подписке. Возвращается только для `payment_model = postpay`

Для налогов — о каждом налоге, использованном при создании списания:

Название		Тип данных	Описание
id		string	ID налога
type		string	Тип данных
attributes		object	Информация о налоге
	created_at	string	Дата и время создания налога
	updated_at	string	Дата и время последнего изменения налога
	charge_id	integer	ID списания, для которого рассчитан налог
	origin_id	integer	ID налога в налоговом модуле
	name	string	Название налога
	code	string	Код налога
	rate	number	Размер налога в процентах
	amount	string	Сумма налога в валюте реселлера, рассчитанная для `net_amount` списания

Для скидки типа Реселлер:

Название		Тип данных	Описание
id		string	ID скидки
type		string	Тип данных
attributes		object	Информация о скидке
	created_at	string	Дата и время создания скидки
	updated_at	string	Дата и время последнего изменения скидки
	status	string	Название скидки
	type	string	Тип скидки
	percentage	string	Размер скидки в процентах
	duration_from	string	Дата начала действия скидки
	duration_to	string	Дата окончания действия скидки

links object Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

self string Ссылка на текущую страницу

first string Ссылка на первую страницу

prev string Ссылка на предыдущую страницу

next string Ссылка на следующую страницу

last string Ссылка на последнюю страницу

meta object Дополнительная информация о списании

currency string Код валюты реселлера

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

GET /api/v3/resellers/545/charges?page[size]=2&page[number]=3113
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "190037",
            "type": "charges",
            "attributes": {
                "created_at": "2025-06-10T11:44:27.324909+0300",
                "updated_at": "2025-06-10T11:49:53.979192+0300",
                "subscription_id": 3018327,
                "subscription_resource_id": 67259,
                "operate_from": "2026-05-01",
                "description": "Upgrade resource (recurring fee) \"Microsoft 365 E3 (no Teams)\" for Subscription #3018327 \"Microsoft 365 E3 (no Teams)\"",
                "unit_price": "2.0",
                "amount": "18.7",
                "status": "deleted",
                "type": "Charge::Recurring",
                "net_cost": "18.7",
                "net_amount": "17.0",
                "taxes_amount": "1.7",
                "unit_price_currency": "USD",
                "quantity": 10.0,
                "duration": 1.0,
                "subscription_resource_name": "Microsoft 365 E3 (no Teams)",
                "plan_resource_id": 31622,
                "resource_id": 16873,
                "order_id": 35776,
                "operate_to": "2026-05-31",
                "close_date": "2026-05-31",
                "billing_date": null,
                "application_template_key": "",
                "additional_params": [
                    {
                        "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "tenant_name": "demoNewAcc.onmicrosoft.com",
                        "subscription_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "order_id": "CFQ7TTC0LFLX",
                        "alternate_id": "CFQ7TTC0LFLX",
                        "activation_link": null,
                        "product_id": "CFQ7TTC0LFLX",
                        "sku_id": "0021",
                        "term_duration": "P1Y",
                        "billing_cycle": "annual"
                    }
                ],
                "discount": "3.00",
                "original_amount": "18.7",
                "original_amount_currency": "USD",
                "currency_rate": "1.0",
                "currency_unit": 1,
                "net_cost_original": "18.7",
                "net_cost_currency_rate": "1.0",
                "net_cost_currency_unit": 1,
                "net_cost_original_currency": "USD",
                "tax_is_calculated_using": "net_prices"
            },
            "relationships": {
                "taxes": {
                    "data": [
                        {
                            "id": "17951",
                            "type": "taxes"
                        }
                    ]
                },
                "reseller": {
                    "data": {
                        "id": "545",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "2814",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3018327",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "26163",
                        "type": "plans"
                    }
                },
                "plan_resource": {
                    "data": {
                        "id": "31622",
                        "type": "plan_resources"
                    }
                },
                "discount": {
                    "data": {
                        "id": "360",
                        "type": "discounts"
                    }
                },
                "reseller_discount": {
                    "data": {
                        "id": "361",
                        "type": "discounts"
                    }
                },
                "order": {
                    "data": {
                        "id": "35776",
                        "type": "sales_orders"
                    }
                }
            }
        },
        {
            "id": "190038",
            "type": "charges",
            "attributes": {
                "created_at": "2025-06-10T11:44:27.332400+0300",
                "updated_at": "2025-06-10T11:49:53.988693+0300",
                "subscription_id": 3018327,
                "subscription_resource_id": 67259,
                "operate_from": "2026-06-01",
                "description": "Upgrade resource (recurring fee) \"Microsoft 365 E3 (no Teams)\" for Subscription #3018327 \"Microsoft 365 E3 (no Teams)\"",
                "unit_price": "2.0",
                "amount": "5.61",
                "status": "deleted",
                "type": "Charge::Recurring",
                "net_cost": "5.61",
                "net_amount": "5.1",
                "taxes_amount": "0.51",
                "unit_price_currency": "USD",
                "quantity": 10.0,
                "duration": 0.3,
                "subscription_resource_name": "Microsoft 365 E3 (no Teams)",
                "plan_resource_id": 31622,
                "resource_id": 16873,
                "order_id": 35776,
                "operate_to": "2026-06-09",
                "close_date": "2026-06-30",
                "billing_date": null,
                "application_template_key": "",
                "additional_params": [
                    {
                        "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "tenant_name": "demoNewAcc.onmicrosoft.com",
                        "subscription_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                        "order_id": "CFQ7TTC0LFLX",
                        "alternate_id": "CFQ7TTC0LFLX",
                        "activation_link": null,
                        "product_id": "CFQ7TTC0LFLX",
                        "sku_id": "0021",
                        "term_duration": "P1Y",
                        "billing_cycle": "annual"
                    }
                ],
                "discount": "0.90",
                "original_amount": "5.61",
                "original_amount_currency": "USD",
                "currency_rate": "1.0",
                "currency_unit": 1,
                "net_cost_original": "5.61",
                "net_cost_currency_rate": "1.0",
                "net_cost_currency_unit": 1,
                "net_cost_original_currency": "USD",
                "tax_is_calculated_using": "net_prices"
            },
            "relationships": {
                "taxes": {
                    "data": [
                        {
                            "id": "17952",
                            "type": "taxes"
                        }
                    ]
                },
                "reseller": {
                    "data": {
                        "id": "545",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "2814",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3018327",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "26163",
                        "type": "plans"
                    }
                },
                "plan_resource": {
                    "data": {
                        "id": "31622",
                        "type": "plan_resources"
                    }
                },
                "discount": {
                    "data": {
                        "id": "360",
                        "type": "discounts"
                    }
                },
                "reseller_discount": {
                    "data": {
                        "id": "361",
                        "type": "discounts"
                    }
                },
                "order": {
                    "data": {
                        "id": "35776",
                        "type": "sales_orders"
                    }
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/545/charges?page%5Bnumber%5D=3113&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/545/charges?page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/545/charges?page%5Bnumber%5D=3112&page%5Bsize%5D=2",
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/545/charges?page%5Bnumber%5D=3113&page%5Bsize%5D=2"
    },
    "meta": {
        "currency": "USD"
    }
}