Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Events

Ingest a usage event

Send a single usage event. Uses transactionId for idempotency - sending the same transactionId twice will return the existing event.

post/api/events

Request body

transactionIdstring required

Unique transaction ID for idempotency

subscriptionIdstring required

Subscription ID or external subscription ID

codestring required

Billable metric code

timestampstring

Event timestamp (defaults to now)

propertiesobject

Event properties

Example request

{
  "transactionId": "evt_12345",
  "subscriptionId": "sub_abc123",
  "code": "api_calls",
  "timestamp": "2026-02-10T12:00:00Z",
  "properties": {
    "tokens": 1500,
    "region": "us-east"
  }
}

Response

Event ingested successfully

idstring required
transactionIdstring required
subscriptionIdstring required
codestring required
timestampstring required
propertiesobject
createdAtstring required

Example response

{
  "id": "clx1234567890",
  "transactionId": "txn_unique_123",
  "subscriptionId": "clxsub123",
  "code": "api_calls",
  "properties": {
    "region": "us-east",
    "bytes": 1024
  }
}