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.

remainingCreditsnumber

Credits remaining after depletion. Always 0.

{
  "event": "credits.depleted",
  "timestamp": "2026-06-22T17:45:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "remainingCredits": 0
  }
}

Cuándo se dispara

El procesador asíncrono de uso dispara este evento una vez cuando una deducción lleva el saldo de créditos de positivo a cero. A partir de ese momento, las solicitudes de uso que necesiten más créditos de los que quedan se rechazan con insufficient_credits.

customer.state_changed se dispara junto a él con el trigger credits_depleted, llevando el estado de derechos (entitlement) actual completo del cliente.

Úsalo para bloquear las funciones restringidas de tu aplicación y dirigir al cliente a la compra de un paquete de créditos.