Skip to main content
POST
Report custom billing event (PER_USE, OAuth only)

Authorizations

Authorization
string
header
required

OAuth2 access token issued via POST /oauth/token

Body

application/json
event
string
required

Event name matching a configured billing meter

Maximum string length: 100
Example:

"generate_report"

idempotency_key
string
required

Unique key to prevent duplicate charges

Maximum string length: 128
Example:

"order-12345"

metadata
object

Arbitrary key-value pairs for tracking

Response

Event processed successfully

charged
number
required

Credits charged for this event

balance_remaining
number
required

Remaining credit balance

idempotent_replay
boolean

True if this was a duplicate request (no additional charge)