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.

currentBalancenumber

The remaining balance in rate scale (10000 = $1.00 of the subscription currency).

thresholdBalancenumber

The low-balance threshold that was crossed: 10% of the last refill, in rate scale.

currencystring

The subscription currency.

{
  "event": "balance.low",
  "timestamp": "2026-06-18T09:12:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "currentBalance": 90000,
    "thresholdBalance": 100000,
    "currency": "usd"
  }
}

Cuándo se dispara

El procesador asíncrono de uso observa cada deducción de saldo. Cuando un lote lleva el saldo prepago de estar por encima a estar en o por debajo del 10% de la última recarga (reinicio del período, recarga o ajuste manual), este evento se dispara una vez por cruce. Una recarga lo rearma.

Los montos están en escala de tarifa (10000 = $1.00) en la moneda de la suscripción.

Úsalo para incentivar al cliente a recargar antes de que se bloquee el uso.