RevKeenDocs

Query usage events

List usage events with optional filters. Returns up to 100 events per request.


Related endpoints

  • POST /usage-events — Ingest usage events
  • POST /usage-events/dry-run — Dry-run usage events
  • GET /usage-events/aggregate/{meterId} — Get aggregated usage

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/usage-events
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

meter_id?string

Filter by meter ID

customer_id?string

Filter by customer ID

external_customer_id?string

Filter by external customer ID

subscription_id?string

Filter by subscription ID

start_time?string

Start of time range (ISO 8601)

end_time?string

End of time range (ISO 8601)

limit?string

Max results (default 100, max 100)

Response Body

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/usage-events" \
  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
      "meter_id": "1e13adc1-9ac9-453b-b100-17d2f2da2eb8",
      "quantity": 0,
      "event_time": "2019-08-24T14:15:22Z",
      "idempotency_key": "string",
      "external_id": "string",
      "source": "string",
      "metadata": {},
      "properties": {},
      "ingestion_timestamp": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true
}
{
  "error": "string"
}