GET /v1/usage

Retrieve your current-month usage statistics and credit balance.

Request

GET /v1/usage

Requires Authorization: Bearer vch_... header. No request body or query parameters.

Response

FieldTypeDescription
periodobjectstart and end ISO timestamps for the current month.
total_checksintegerTotal checks this month.
cached_checksintegerChecks served from cache (free).
billable_checksintegerChecks that deducted credits.
credits_usedintegerCredits consumed this month.
credits_balanceintegerCurrent credit balance.

Example

Request
curl https://api.vouchley.getrevlio.com/v1/usage \
  -H "Authorization: Bearer $VOUCHLEY_API_KEY"
Response 200
{
  "period": {
    "start": "2026-04-01T00:00:00+00:00",
    "end": "2026-04-20T14:30:00+00:00"
  },
  "total_checks": 1247,
  "cached_checks": 312,
  "billable_checks": 935,
  "credits_used": 935,
  "credits_balance": 2065
}