Balances
Limit Reached
Fired when a customer reaches the limit for a feature (included allowance, max purchase, or spend limit).
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'
required
Which limit was hit: included allowance, max purchase cap, or spend limit.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200
Webhook received successfully.