Skip to main content

​
When this fires

Once per feature per billing period, when period usage passes the included quantity:
  • Overage enabled (overageEnabled: true): overage billing began — every unit past the included amount will be charged at renewal.
  • Overage disabled (overageEnabled: false): the hard limit was hit — further usage requests for this feature are rejected. This case also fires customer.state_changed with trigger quota_exceeded, since the customer’s access changed.
Use it to surface overage charges in your UI, or to block the feature when the limit is hard.

Body

application/json
​
id
string
required
​
event
string
required
Allowed value: "quota.exceeded"
​
timestamp
string
required
​
organizationId
string
required
​
mode
enum<string>
required
Available options:
live,
sandbox
​
apiVersion
string
required
​
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.