Skip to main content

When this fires

When a subscription is created without a payment method on file, Commet generates a hosted checkout link for the first invoice and fires this event as soon as the link is ready. Commet also emails the link to the customer — this webhook lets you deliver it through your own channels (in-app banner, chat, SMS) instead of relying on email alone. The link stays valid until the invoice is paid or voided. Trials with their own checkout flow fire trial.checkout_ready instead. Use the checkoutUrl to put the payment link in front of the customer wherever they already are.

Body

application/json
id
string
required
event
string
required
Allowed value: "checkout.ready"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.