BRbrapi-dev
Conta

Uso da conta

Changed on

Quanto da sua cota você já gastou na janela atual.

A resposta traz planName (free, startup ou pro), planLimit com o limite do plano, currentUsage com o consumo registrado, remainingUsage com o saldo, usageWindow indicando se a contagem é por ciclo de cobrança ou por 30 dias móveis, e subscriptionPeriod com o período atual da assinatura.

A contagem vem do mesmo cache que o limitador usa, então ela pode ficar alguns segundos atrás do consumo real.

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

Request

  • Base URL
    https://brapi.dev
  • URL
    https://brapi.dev/api/v2/user/usage
  • Auth
    HTTP bearer

Query parameters

format'json'

Formato da resposta. JSON é o formato suportado.

Response

Uso da conta retornado com sucesso.

requestedAtstring date-time required

Data e hora da requisição em 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
}

Changes