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.

includedAmountnumber

The included quantity for the period.

overageEnabledboolean

True when overage billing began; false when the hard limit was hit and usage is now blocked.

periodStartstring

ISO 8601 start of the usage period.

{
  "event": "quota.exceeded",
  "timestamp": "2026-06-22T17:45:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "featureCode": "api_calls",
    "currentUsage": 1080,
    "includedAmount": 1000,
    "overageEnabled": true,
    "periodStart": "2026-06-01T00:00:00.000Z"
  }
}

Cuándo se dispara

Una vez por función por período de facturación, cuando el uso del período supera la cantidad incluida:

Excedente habilitado (overageEnabled: true): comenzó la facturación por excedente — cada unidad más allá del monto incluido se cobrará en la renovación.
Excedente deshabilitado (overageEnabled: false): se alcanzó el límite estricto — las solicitudes de uso posteriores para esta función se rechazan. Este caso también dispara customer.state_changed con el trigger quota_exceeded, ya que el acceso del cliente cambió.

Úsalo para mostrar los cargos por excedente en tu UI, o para bloquear la función cuando el límite es estricto.