Skip to main content
POST
Create a usage subscription

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string
required

1–255 printable ASCII characters without spaces. Reuse the same key and payload when retrying. For usage events, eventId is also a durable duplicate-prevention key per subscription.

Example:

"usage-intent-123"

Body

application/json
customerRef
string
required
overageLimit
string
required
Pattern: ^(0|[1-9]\d{0,19})(\.\d{1,18})?$
planId
string
required

Response

The scoped resource. Duplicate creates return the original resource.

data
object
required