Uso
Monitore sua cota API, créditos extras e status da conta em tempo real.
O endpoint de Uso retorna a cota API restante, créditos extras, limites de taxa e detalhes da chave de API a qualquer momento. Ele não consome créditos.
Nota: o objeto subscription reflete a cota API combinada (assinatura + top-ups restantes), não apenas a parte da assinatura. O painel exibe a divisão Assinatura / Top-ups.
Este endpoint é gratuito. Nunca consome créditos.
Requisição
curl "https://api.piloterr.com/v2/usage" \
-H "x-api-key: YOUR_API_KEY"Campos de resposta
| Campo | Tipo | Descrição |
|---|---|---|
remaining | integer | Total de créditos disponíveis (cota API + créditos extras) |
total_used | integer | Total de créditos consumidos até agora (cota API + extras; uso de top-ups persiste entre períodos) |
renewal_date | string | Data de renovação da assinatura (ISO 8601) |
period.start | string | Início do período de faturamento atual |
period.end | string | Fim do período de faturamento atual |
subscription.used | integer | Chamadas API usadas contra a cota API combinada |
subscription.total | integer | Limite de cota API combinada (assinatura + top-ups) |
subscription.remaining | integer | Cota API combinada restante (parte da assinatura + top-ups não usados) |
subscription.percent_used | number | Percentual da cota API consumida |
credits.given | integer | Créditos extras concedidos (saldo separado) |
credits.consumed | integer | Créditos extras consumidos |
credits.remaining | integer | Créditos extras restantes |
rate_limit.per_minute | integer | null | Limite de requisições por minuto (null = ilimitado) |
rate_limit.per_second | integer | null | Limite de requisições por segundo (null = ilimitado) |
account.name | string | Nome da conta |
account.slug | string | Identificador da conta |
api_key.alias | string | Nome amigável da chave de API |
api_key.active | boolean | Se a chave está atualmente ativa |
api_key.category | string | Categoria da chave (ex. development, production) |
api_key.expires | string | null | Data de expiração da chave (null = nunca expira) |
api_key.quotas | object | Cotas personalizadas por chave: total, daily, weekly, monthly |
Exemplo de resposta
{
"remaining": 450,
"total_used": 1550,
"renewal_date": "2026-04-25",
"period": {
"start": "2026-03-25",
"end": "2026-04-25"
},
"subscription": {
"used": 1550,
"total": 2000,
"remaining": 450,
"percent_used": 77
},
"credits": {
"given": 0,
"consumed": 0,
"remaining": 0,
"percent_used": 0
},
"rate_limit": {
"per_minute": null,
"per_second": null
},
"account": {
"name": "Acme Corp",
"slug": "acme-corp"
},
"api_key": {
"alias": "production",
"active": true,
"category": "production",
"expires": null,
"quotas": {
"total": null,
"daily": null,
"weekly": null,
"monthly": null
}
}
}