quota.threshold_reached

{ "event": "quota.threshold_reached", "timestamp": "2026-06-23T14:30:00.000Z", "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f", "mode": "live", "apiVersion": "2026-08-27", "data": { "subscriptionId": "sub_1a2b3c4d", "customerId": "user_123", "featureCode": "api_calls", "currentUsage": 850, "includedAmount": 1000, "periodStart": "2026-06-01T00:00:00.000Z" } }

When this fires

For metered plans, the async usage processor compares each feature’s period usage against its included quantity. When usage crosses 80% of the included amount, this fires once for that feature and billing period. Unlimited features never fire it.

If a single burst jumps straight past the included amount, only quota.exceeded fires.

Use it to warn the customer they are approaching their limit.

Body

application/json

string

required

event

string

required

Allowed value: "quota.threshold_reached"

timestamp

string

required

organizationId

string

required

mode

enum<string>

required

Available options:

live,

sandbox

apiVersion

string

required

data

object

required

Show child attributes

Response

200

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

Overview

Events

quota.threshold_reached

When this fires

Body

Response

​When this fires

Body

Response

When this fires