{
"type": "balances.limit_reached",
"data": {
"customer_id": "org_123",
"entity_id": "workspace_abc",
"feature_id": "api_calls",
"limit_type": "included"
}
}Balances
Limit Reached
Fired when a customer reaches the limit for a feature (included allowance, max purchase, spend limit, or a usage-limit billing control).
WEBHOOK
balances.limit_reached
{
"type": "balances.limit_reached",
"data": {
"customer_id": "org_123",
"entity_id": "workspace_abc",
"feature_id": "api_calls",
"limit_type": "included"
}
}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.
object
The filter of the usage limit that blocked, when a filtered cap was hit.
Show properties
Show properties
string
required
object
The usage limit that blocked, with its live window. Present only when limit_type is usage_limit.
Show properties
Show properties
number
required
Maximum units allowed per interval.
'day' | 'week' | 'month' | 'year'
required
Interval of the cap.
'billing_cycle' | 'utc'
required
Window alignment the cap was configured with.
number
required
Units consumed in the current window, after this event.
number
required
Units left in the current window, never below zero.
number
required
Start of the current window, in milliseconds since epoch.
number
required
End of the current window, in milliseconds since epoch.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200
Webhook received successfully.