Get Usage

Get customer usage metrics

GET /admin/usage/{customer_id}

Get Usage

cURL

curl --request GET \
  --url https://api.example.com/admin/usage/{customer_id}

200 OK

{
  "customer_id": "550e8400-e29b-41d4-a716-446655440000",
  "tier": "growth",
  "annual_limit": 10000000,
  "usage": {
    "current_month": {
      "period": "2026-01",
      "count": 125000
    },
    "current_year": {
      "period": "2026",
      "count": 125000
    }
  },
  "usage_percent": 1.25,
  "remaining": 9875000
}

Retrieve usage metrics for a specific customer including current month and year-to-date counts.

Path Parameters

customer_id · string · required

Customer UUID

Response

customer_id · string

Customer identifier

tier · string

Customer’s pricing tier

annual_limit · number

Annual validation limit

usage · object

Usage breakdown

Show usage properties

current_month · object

Current month usage

Show current_month properties

period · string

Month period (YYYY-MM)

count · number

Validation count for the month

current_year · object

Year-to-date usage

Show current_year properties

period · string

Year period (YYYY)

count · number

Total validation count for the year

usage_percent · number

Percentage of annual limit used

remaining · number

Remaining validations for the year

200 OK

{
  "customer_id": "550e8400-e29b-41d4-a716-446655440000",
  "tier": "growth",
  "annual_limit": 10000000,
  "usage": {
    "current_month": {
      "period": "2026-01",
      "count": 125000
    },
    "current_year": {
      "period": "2026",
      "count": 125000
    }
  },
  "usage_percent": 1.25,
  "remaining": 9875000
}

Example

cURL

curl -X GET "https://{admin-api-url}/admin/usage/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: ADMIN_API_KEY"