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.

invoiceIdstring

The invoice issued for the top-up.

invoiceNumberstring

The human-readable invoice number.

amountnumber

The topped-up value in rate scale (10000 = $1.00 of the subscription currency).

currencystring

The subscription currency.

{
  "event": "balance.topped_up",
  "timestamp": "2026-06-15T11:20:00.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "invoiceId": "inv_t1u2v3",
    "invoiceNumber": "INV-0051",
    "amount": 500000,
    "currency": "usd"
  }
}

Cuándo se dispara

Cuando un cliente en un plan de saldo recarga su saldo prepago a través del portal de clientes y el pago se realiza con éxito.

amount es el valor recargado en escala de tarifa (10000 = $1.00 de la moneda de la suscripción) — la misma escala que usan balance.low y balance.depleted.

Úsalo para confirmar la recarga en tu propia UI y para limpiar cualquier aviso de saldo bajo que hayas mostrado en balance.low.