Skip to main content
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

​
customer_id
string
required
The ID of the customer who hit the limit.
​
entity_id
string
The entity ID, if the limit was reached on a specific entity.
​
feature_id
string
required
The feature ID whose limit was reached.
​
limit_type
'included' | 'max_purchase' | 'spend_limit'
required
Which limit was hit: included allowance, max purchase cap, or spend limit.

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:
{
  "customer_id": "org_123",
  "entity_id": "workspace_abc",
  "feature_id": "api_calls",
  "limit_type": "included"
}

Response

200

Webhook received successfully.