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-23T14:30:00.000Z",
  "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f",
  "mode": "live",
  "apiVersion": "2026-07-31",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "featureCode": "api_calls",
    "currentUsage": 850,
    "includedAmount": 1000,
    "periodStart": "2026-06-01T00:00:00.000Z"
  }
}

Cuándo se dispara

Para planes medidos, el procesador asíncrono de uso compara el uso del período de cada función con su cantidad incluida. Cuando el uso cruza el 80% del monto incluido, esto se dispara una vez para esa función y período de facturación. Las funciones ilimitadas nunca lo disparan.

Si una sola ráfaga salta directamente más allá del monto incluido, solo se dispara quota.exceeded.

Úsalo para advertir al cliente que se está acercando a su límite.