Метод используется для получения многостраничного списка заблокированных списаний на балансе аккаунта, к которому есть доступ у текущего пользователя.
GET {reseller_domain}/internal_api/accounts/{account_id}/blocked_charges
В этой статье:
Авторизация
Требуется авторизация с помощью 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 пользователя. Формат: |
||||
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
||||
|
account_id |
path |
integer |
Обязательный |
ID аккаунта, для которого запрашивается список заблокированных списаний |
||||
|
page[size] |
query |
integer |
Опциональный |
Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) |
||||
|
page[number] |
query |
integer |
Опциональный |
Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию) |
||||
|
sort |
query |
string |
Опциональный |
Предназначен для сортировки элементов списка по указанному параметру. Доступные значения:
|
||||
|
include |
query |
string |
Опциональный |
Предназначен для включения в ответ дополнительной информации о связанных объектах:
|
Модель ответа
Пример запроса
curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/95/blocked_charges?include=taxes' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'
Пример ответа
{
"data": [
{
"id": "6926",
"type": "charge_recurrings",
"attributes": {
"created_at": "2023-04-11T11:27:59.590891+0000",
"type": "Charge::Recurring",
"description": "Upgrade resource (recurring fee) \"Licenses\" for Subscription #1687 \"Office\" from 24.02.2023 to 28.02.2023",
"quantity_float": "1.0",
"duration_float": "0.179",
"operate_from": "2023-02-24",
"operate_to": "2023-03-01",
"unit_price": "11.00 €",
"discount_amount": "0.00 €",
"amount": "2.39 €",
"total": 2.39,
"tax_is_calculated_using": "net_prices",
"net_amount": 1.97,
"taxes_amount": "0.42 €",
"reseller_currency_iso_code": "EUR",
"item_target_data": {
"target_id": 2030,
"target_type": "SubscriptionResource",
"type": "ProvisioningItem::Upgrade",
"description": "Licenses"
},
"subscription": {
"id": 1687,
"name": "Office",
"billing_type": "csp_monthly",
"payment_model": "prepay"
},
"original_amount": 2.39,
"unit_price_currency": "EUR"
},
"relationships": {
"taxes": {
"data": [
{
"id": "7770",
"type": "taxes"
},
{
"id": "7769",
"type": "taxes"
},
{
"id": "7768",
"type": "taxes"
}
]
}
}
}
],
"included": [
{
"id": "7770",
"type": "taxes",
"attributes": {
"charge_id": 6926,
"origin_id": 38,
"name": "Regional tax",
"code": "reg",
"rate": 8.0,
"amount": 0.16,
"created_at": "2023-04-11T11:27:59.603446+0000",
"updated_at": "2023-04-11T11:27:59.603446+0000"
}
},
{
"id": "7769",
"type": "taxes",
"attributes": {
"charge_id": 6926,
"origin_id": 18,
"name": "Local Tax",
"code": "loc",
"rate": 2.0,
"amount": 0.04,
"created_at": "2023-04-11T11:27:59.602363+0000",
"updated_at": "2023-04-11T11:27:59.602363+0000"
}
},
{
"id": "7768",
"type": "taxes",
"attributes": {
"charge_id": 6926,
"origin_id": 20,
"name": "VAT",
"code": "vat",
"rate": 11.0,
"amount": 0.22,
"created_at": "2023-04-11T11:27:59.600455+0000",
"updated_at": "2023-04-11T11:27:59.600455+0000"
}
}
],
"links": {
"self": "https://test.activeplatform.com/internal_api/accounts/95/blocked_charges?include=taxes&page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "https://test.activeplatform.com/internal_api/accounts/95/blocked_charges?include=taxes&page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "https://test.activeplatform.com/internal_api/accounts/95/blocked_charges?include=taxes&page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"page_count": 1,
"server_current_time": "2023-06-30 T12:34:56.199973+0300"
}
}