Appearance
GET /apiv2/billing/account
Sua conta pós-paga em detalhes: o limite de crédito definido pela Netts, seu próprio limite geral, quanto você deve e quanto ainda pode gastar agora. Parte do faturamento pós-pago.
URL do endpoint
GET https://netts.io/apiv2/billing/accountCabeçalhos da requisição
| Cabeçalho | 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.
Exemplo
bash
curl -s 'https://netts.io/apiv2/billing/account' \
-H 'X-API-KEY: your-api-key' \
-H 'X-Real-IP: 203.0.113.10'json
{
"success": true,
"data": {
"mode": "postpaid",
"adminLimit": {
"id": 1,
"origin": "netts",
"limit": { "unit": "USD", "value": "30000.000000" },
"used": { "unit": "USD", "value": "1250.400000" },
"available": { "unit": "USD", "value": "28749.600000" },
"creditApplied": { "unit": "USD", "value": "0" },
"status": "ok",
"revision": 3,
"editable": false
},
"clientLimit": {
"id": 4,
"origin": "client",
"limit": { "unit": "USD", "value": "5000.000000" },
"used": { "unit": "USD", "value": "1250.400000" },
"available": { "unit": "USD", "value": "3749.600000" },
"creditApplied": { "unit": "USD", "value": "0" },
"status": "ok",
"revision": 2,
"editable": true
},
"effectiveAvailable": { "unit": "USD", "value": "3749.600000" },
"pendingUnbilled": { "trx": "0", "count": 0 },
"asOf": "2026-10-19T20:24:26.474237+00:00",
"settlement": { "asset": "USDC", "network": "ethereum", "paymentTermsDays": 5 },
"limit": { "unit": "USD", "value": "30000.000000" },
"unpaid": { "TRX": "3778.500000", "USDC": "1250.400000" },
"creditUsdc": "0",
"available": "28749.600000",
"availableTrxEquiv": "86897.437285",
"availableUsdEquiv": "28749.600000",
"fx": { "usdPerTrx": "0.33084276", "at": "2026-10-19T20:24:23.449930+00:00" },
"fxStatus": "ok"
},
"timestamp": "2026-10-19T20:24:26+00:00"
}Campos da resposta
| Campo | Descrição |
|---|---|
mode | postpaid, ou prepaid enquanto o faturamento pós-pago da conta estiver pausado |
adminLimit | o limite de crédito definido pela Netts. editable é sempre false |
clientLimit | seu próprio limite geral, ou null se você não definiu um |
adminLimit.used / clientLimit.used | quanto do limite foi utilizado |
adminLimit.available / clientLimit.available | quanto resta do limite |
creditApplied | seu crédito decorrente de pagamentos a mais que já reduz a dívida neste limite |
status | ok, limit_reached, ou unavailable se não puder ser calculado no momento |
effectiveAvailable | o que você pode gastar agora: o menor dos dois valores de available |
pendingUnbilled | pedidos já aceitos cuja cobrança ainda está sendo registrada: seu total em TRX e contagem |
asOf | o momento em que os números foram calculados |
settlement | como você paga as faturas sob o seu contrato: a moeda, a rede e o prazo em dias para pagar uma fatura |
limit, unpaid, creditUsdc, available | o limite da Netts, o valor não pago em TRX e na moeda do seu contrato, seu crédito e o que resta do limite da Netts |
availableTrxEquiv, availableUsdEquiv | available convertido à taxa em fx; null quando nenhuma taxa estiver disponível |
fx | a taxa atual de TRX para a moeda do seu contrato e o momento em que foi obtida. É uma estimativa para comparação, não a taxa de um pedido futuro — consulte taxa de câmbio registrada |
fxStatus | ok, ou unavailable — nesse caso os equivalentes são null, os valores ainda são exibidos |
used e available são calculados da mesma forma que um pedido é verificado, portanto effectiveAvailable é o que o próximo pedido pode utilizar. Os limites de produtos são mostrados em limites.
Erros
| 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 da API, consulte 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.