v20

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-2176162684.2 KB
Conta

Obter uso atual da conta autenticada

Retorna o uso atual da conta autenticada usando a mesma contagem cacheada do limitador de uso.

O que retorna

  • planName — plano atual da conta (free, startup, pro)
  • planLimit — limite de requisições do plano
  • currentUsage — uso atual contabilizado no banco
  • remainingUsage — saldo restante dentro da janela atual
  • usageWindow — janela usada para contagem (billing-cycle ou rolling-30d)
  • subscriptionPeriod — período atual de assinatura salvo no usuário

Autenticação

Bearer token ou query param token.

Exemplo

curl -H "Authorization: Bearer SEU_TOKEN" "https://brapi.dev/api/v2/user/usage"
get/api/v2/user/usage

Response

Uso da conta retornado com sucesso.

requestedAtstring date-time required

Data e hora da requisição em formato ISO 8601

tookinteger required

Tempo de processamento em milissegundos

Example response

{
  "usage": {
    "planName": "pro",
    "planLimit": 500000,
    "currentUsage": 1248,
    "remainingUsage": 498752,
    "usageWindow": {
      "type": "billing-cycle",
      "start": "2026-04-01T00:00:00.000Z",
      "end": "2026-05-01T00:00:00.000Z"
    },
    "subscriptionPeriod": {
      "start": "2026-04-01T00:00:00.000Z",
      "end": "2026-05-01T00:00:00.000Z"
    }
  },
  "requestedAt": "2026-04-07T20:45:10.000Z",
  "took": 18
}