Appearance
GET /apiv2/billing/invoices
Suas faturas pós-pagas. Ao final do período de faturamento definido em seu contrato, uma fatura é emitida para os serviços desse período; cada fatura tem uma data de vencimento. Parte do faturamento pós-pago.
Endpoints
| Endpoint | Retorna |
|---|---|
GET /apiv2/billing/invoices | todas as faturas, período mais recente primeiro |
GET /apiv2/billing/invoices/{id} | uma fatura com suas cobranças |
Cabeç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 |
Exemplo
bash
curl -s 'https://netts.io/apiv2/billing/invoices/12' \
-H 'X-API-KEY: your-api-key' \
-H 'X-Real-IP: 203.0.113.10'json
{
"success": true,
"data": {
"id": 12,
"periodStart": "2026-10-12T00:00:00+00:00",
"periodEnd": "2026-10-19T00:00:00+00:00",
"totalTrx": "3778.500000",
"totalUsdc": "1250.400000",
"paidUsdc": "0.000000",
"status": "issued",
"issuedAt": "2026-10-19T00:10:00+00:00",
"dueAt": "2026-10-24T00:10:00+00:00",
"charges": [
{
"id": 1024,
"orderId": "AB2EF201B582AA1",
"productCode": "energy_1h",
"amountTrx": "1.300000",
"amountUsdc": "0.430096",
"status": "invoiced"
}
]
},
"timestamp": "2026-10-19T20:31:10+00:00"
}Cada cobrança possui os mesmos campos que em uso; o exemplo mostra alguns deles.
Uma fatura
| Campo | Descrição |
|---|---|
id | o número da fatura |
periodStart, periodEnd | o período de faturamento que a fatura cobre, UTC |
totalTrx, totalUsdc | o total da fatura, em TRX e na moeda do seu contrato |
paidUsdc | quanto já foi pago, na moeda do seu contrato |
status | issued, delivered, partially_paid, paid ou void |
issuedAt | quando a fatura foi emitida |
dueAt | a data limite para pagamento |
charges | apenas em /invoices/{id}: as cobranças da fatura |
O endpoint de listagem retorna os mesmos campos sem charges. Uma conta sem faturas ainda recebe uma lista vazia.
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 de API, consulte o formato de resposta |
| 403 | billing_read_required, postpaid_required | sem permissão, ou sem faturamento pós-pago |
| 404 | not_found | nenhuma fatura encontrada na sua conta |