GET /apiv2/billing/limits

Todos os limites da sua conta pós-paga — o limite de crédito definido pela Netts e os seus próprios limites — com o quanto de cada um foi utilizado e resta, e o quanto cada produto ainda pode gastar. Parte do faturamento pós-pago.

URL do endpoint

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

Cabeçalhos da requisição

Header	Obrigatório	Descrição
X-API-KEY	sim	Chave de API com a permissão billing.read
X-Real-IP	sim	Um endereço da lista de permissões da chave

A requisição não possui parâmetros.

Exemplos

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

{
  "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"
}

Um limite

Campo	Descrição
id	o número do limite — use-o para alterar, desativar ou ativar o seu próprio limite
scope	account — aplica-se a toda a conta; key — aplica-se a uma chave de API (apiKeyId)
origin	netts — definido pela Netts, somente leitura; client — seu próprio limite
editable, canDisable	se você pode alterar ou desativar este limite
period	outstanding, day, week ou order — veja o que é contabilizado
productCode	o produto ao qual o limite se aplica, null para um limite geral
enabled	false — o limite está desativado e não se aplica
revision	a versão atual; envie-a como expectedRevision quando você alterar o limite
limit, equivalent	o limite e, para referência, seu valor na outra moeda na cotação atual
used, available	quanto foi utilizado e resta; null para um limite desativado e para limites de order
creditApplied	crédito de pagamentos a mais contabilizado em um limite outstanding
maxPerOrder	para um limite de order: o maior pedido individual
periodStart, periodEnd	para day e week: o período UTC atual
cappedBy	o seu limite é maior do que o limite da Netts depois que a Netts o reduziu: o id do limite da Netts que se aplica em vez dele
status	ok, limit_reached, disabled, other_key (um limite de outra das suas chaves), ou unavailable

Produtos

products mostra, para cada produto, quanto o próximo pedido daquele produto pode gastar: spendable é o menor valor restante entre todos os limites aplicáveis, e limitingLimitIds indica os limites que o definem. maxPerOrder é o maior pedido individual se um limite de order for aplicável.

Os limites da chave são contabilizados para a chave que fez esta requisição — checkedApiKeyId. Se os números não puderem ser calculados no momento, valuationStatus será unavailable: os limites ainda serão listados, e used, available e spendable serão null. Eles nunca são exibidos como zero ou ilimitados nesse caso.

Respostas de erro

HTTP	code	Significado
401	-1, -2	a chave está ausente ou é inválida, ou o IP não está na lista de permissões — respondido pelo gateway de API, consulte o formato de resposta
403	billing_read_required	a chave não possui a permissão billing.read
403	postpaid_required	a conta não possui faturamento pós-pago

Todos os códigos estão listados em faturamento pós-pago.