Payload

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

subscriptionIdstring

The subscription ID.

customerIdstring

The customer ID. Returns your externalId if you provided one when creating the customer, otherwise returns the Commet publicId.

featureCodestring

The metered feature code.

currentUsagenumber

Total usage in the current period after the crossing.

includedAmountnumber

The included quantity for the period.

periodStartstring

ISO 8601 start of the usage period.

{
  "event": "quota.threshold_reached",
  "timestamp": "2026-06-18T09:12:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "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.