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 this checkout collects.

invoiceNumberstring

The human-readable invoice number.

invoiceTotalnumber

Invoice total in cents (100 = $1.00).

invoiceCurrencystring

The invoice currency code.

checkoutUrlstring

The hosted checkout URL to share with the customer.

{
  "event": "checkout.ready",
  "timestamp": "2026-03-25T14:30:05.000Z",
  "organizationId": "org_abc123",
  "mode": "live",
  "apiVersion": "2026-06-10",
  "data": {
    "subscriptionId": "sub_1a2b3c4d",
    "customerId": "user_123",
    "invoiceId": "inv_k1l2m3",
    "invoiceNumber": "INV-0042",
    "invoiceTotal": 9900,
    "invoiceCurrency": "usd",
    "checkoutUrl": "https://pay.commet.co/checkout/tok_9f8e7d6c"
  }
}

Cuándo se dispara

Cuando se crea una suscripción sin un método de pago registrado, Commet genera un enlace de checkout alojado para la primera factura y dispara este evento en cuanto el enlace está listo. Commet también envía el enlace por email al cliente: este webhook te permite entregarlo a través de tus propios canales (banner in-app, chat, SMS) en lugar de depender solo del email.

El enlace permanece válido hasta que la factura se paga o se anula. Las pruebas con su propio flujo de checkout disparan trial.checkout_ready en su lugar.

Usá el checkoutUrl para poner el enlace de pago frente al cliente donde sea que ya esté.