GET /apiv2/billing/limits

Кожен ліміт вашого облікового запису з післяоплатою — кредитний ліміт, встановлений Netts, та ваші власні ліміти — із зазначенням того, скільки з кожного використано й залишилося, а також скільки ще можна витратити на кожен продукт. Частина білінгу з післяоплатою.

URL кінцевої точки

GET https://netts.io/apiv2/billing/limits

Заголовки запиту

Заголовок	Обов'язковий	Опис
`X-API-KEY`	так	Ключ API з дозволом `billing.read`
`X-Real-IP`	так	Адреса з білого списку ключа

Запит не має параметрів.

Приклад

bash

curl -s 'https://netts.io/apiv2/billing/limits' \
  -H 'X-API-KEY: your-api-key' \
  -H 'X-Real-IP: 203.0.113.10'

json

{
  "success": true,
  "data": {
    "limits": [
      {
        "id": 1,
        "scope": "account",
        "origin": "netts",
        "editable": false,
        "canDisable": false,
        "period": "outstanding",
        "productCode": null,
        "apiKeyId": null,
        "enabled": true,
        "revision": 3,
        "limit": { "unit": "USD", "value": "30000.000000" },
        "equivalent": { "unit": "TRX", "value": "90677.230000" },
        "used": { "unit": "USD", "value": "1250.400000" },
        "available": { "unit": "USD", "value": "28749.600000" },
        "creditApplied": { "unit": "USD", "value": "0" },
        "status": "ok",
        "periodStart": null,
        "periodEnd": null,
        "cappedBy": null
      },
      {
        "id": 5,
        "scope": "account",
        "origin": "client",
        "editable": true,
        "canDisable": true,
        "period": "day",
        "productCode": "energy_5m",
        "apiKeyId": null,
        "enabled": true,
        "revision": 1,
        "limit": { "unit": "USD", "value": "200.000000" },
        "equivalent": { "unit": "TRX", "value": "604.514867" },
        "used": { "unit": "USD", "value": "35.200000" },
        "available": { "unit": "USD", "value": "164.800000" },
        "creditApplied": null,
        "status": "ok",
        "periodStart": "2026-10-19T00:00:00+00:00",
        "periodEnd": "2026-10-20T00:00:00+00:00",
        "cappedBy": null
      }
    ],
    "products": {
      "energy_1h": { "unit": "USD", "spendable": "28749.600000", "limitingLimitIds": [1], "maxPerOrder": null, "status": "ok" },
      "energy_5m": { "unit": "USD", "spendable": "164.800000", "limitingLimitIds": [5], "maxPerOrder": null, "status": "ok" }
    },
    "unit": "USD",
    "asOf": "2026-10-19T20:24:26.525887+00:00",
    "checkedApiKeyId": 6,
    "valuationStatus": "ok",
    "creditUsdc": "0",
    "fx": { "usdPerTrx": "0.33084276", "at": "2026-10-19T20:24:23.449930+00:00" },
    "fxStatus": "ok"
  },
  "timestamp": "2026-10-19T20:24:26+00:00"
}

Ліміт

Поле	Опис
`id`	номер ліміту — використовуйте його, щоб змінити, вимкнути або увімкнути власний ліміт
`scope`	`account` — застосовується до всього облікового запису; `key` — застосовується до одного ключа API (`apiKeyId`)
`origin`	`netts` — встановлено Netts, лише для читання; `client` — ваш власний ліміт
`editable`, `canDisable`	чи можете ви змінити або вимкнути цей ліміт
`period`	`outstanding`, `day`, `week` або `order` — див. що враховується
`productCode`	продукт, до якого застосовується ліміт, `null` для загального ліміту
`enabled`	`false` — ліміт вимкнено і він не застосовується
`revision`	поточна версія; надсилайте її як `expectedRevision` під час внесення змін до ліміту
`limit`, `equivalent`	ліміт і, для довідки, його значення в іншій валюті за поточним курсом
`used`, `available`	скільки використано й залишилося; `null` для вимкненого ліміту та для лімітів типу `order`
`creditApplied`	кредит від переплат, врахований у ліміті `outstanding`
`maxPerOrder`	для ліміту `order`: найбільше одиничне замовлення
`periodStart`, `periodEnd`	для `day` та `week`: поточний період UTC
`cappedBy`	ваш ліміт вищий за ліміт Netts після того, як Netts зменшив його: `id` ліміту Netts, який застосовується замість цього
`status`	`ok`, `limit_reached`, `disabled`, `other_key` (ліміт іншого вашого ключа) або `unavailable`

Продукти

products показує для кожного продукту, скільки може використати наступне замовлення цього продукту: spendable — найменша сума, що залишилася серед усіх застосовних лімітів, а limitingLimitIds перелічує ліміти, які її обмежують. maxPerOrder — це найбільше одиничне замовлення, якщо застосовується ліміт order.

Ліміти ключа розраховуються для ключа, який надіслав цей запит — checkedApiKeyId. Якщо значення неможливо обчислити прямо зараз, valuationStatus матиме значення unavailable: ліміти все одно повертаються у списку, але used, available та spendable будуть null. У такому разі вони ніколи не відображаються як нульові або необмежені.

Помилки

HTTP	`code`	Значення
401	`-1`, `-2`	ключ відсутній або недійсний, чи IP-адресу не внесено до білого списку — відповідь від шлюзу API, див. формат відповіді
403	`billing_read_required`	ключ не має дозволу `billing.read`
403	`postpaid_required`	для облікового запису не налаштовано післяоплату

Усі коди наведено в розділі білінг із післяоплатою.

GET /apiv2/billing/limits ​

URL кінцевої точки ​

Заголовки запиту ​

Приклад ​

Ліміт ​

Продукти ​

Помилки ​