Skip to main content
WEBHOOK

​
Payload Fields

​
string
required
The ID of the customer who hit the limit.
​
string
The entity ID, if the limit was reached on a specific entity.
​
string
required
The feature ID whose limit was reached.
​
'included' | 'max_purchase' | 'spend_limit' | 'usage_limit'
required
Which limit was hit: included allowance, max purchase cap, spend limit, or a usage-limit billing control.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
type
string
required

The webhook event type.

Allowed value: "balances.limit_reached"
​
data
object
required
Example:

Response

200

Webhook received successfully.