Browse the docs Open

Usage

Check the meter before you order.

Read the credit balance for the current billing period. Purely informational — it does not consume credits.

Copy as Markdown OpenAPI Postman

GET /v1/usage

Get current usage

Returns purchased, used and remaining requests for the active billing period.

Auth: Bearer token Ability: api_requests Gate: logApiRequest Free

The response carries an `X-Request-Uuid` header you can quote in support tickets.

Example request

curl

curl https://snapsbrew.com/api/v1/usage \
  -H 'Authorization: Bearer <your-token>' \
  -H 'Accept: application/json'

Example responses

200 Usage for the active period.

{
    "period_start_date": "2026-05-01T00:00:00Z",
    "period_end_date": "2026-05-31T23:59:59Z",
    "period_purchased_requests": 1000,
    "period_used_requests": 240,
    "period_available_requests": 760
}

401 Missing or invalid token.

{
    "message": "Unauthenticated."
}