Skip to main content
POST
Ingest usage events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Required on every POST. Nonblank, at most 64 characters after trimming. Scoped to the authenticated tenant. Reuse the same key and request to replay a terminal result. A different payload or a request still in progress returns 409.

Required string length: 1 - 64
Pattern: \S
trace-id
string
required

Body

application/json
Required array length: 1 - 50 elements
eventId
string
required

unique id of this usage event

Required string length: 36 - 64
schemaName
string
required

the schema you defined in usage event schema for this usage event

eventTime
string
required

time of usage event in ISO format

accountNumber
string
required

the customer account consuming this usage

attributes
object[]
Required array length: 1 - 50 elements

Response

OK

success
boolean
errorMessage
string
successDetails
object[]
errorDetails
object[]