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.

expiredCreditsnumber

The unused plan credits that were discarded.

{
  "event": "credits.expired",
  "timestamp": "2026-06-01T00:00:05.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "expiredCredits": 120
  }
}

Cuándo se dispara

Los créditos del plan expiran al final de cada período de facturación: el reinicio del período descarta lo que quedaba y otorga los créditos del nuevo período (lo que dispara credits.granted). Este evento reporta el monto descartado. Los créditos comprados nunca expiran y no se ven afectados.

Solo se dispara cuando había algo que descartar — un cliente que usó todos los créditos del plan no recibe credits.expired.

Úsalo para resúmenes de uso de fin de período ("dejaste 120 créditos sin usar").