Skip to main content

When this fires

When a subscription with a trial is created and the customer still needs to add a payment method, Commet generates a checkout link that starts the trial once completed and fires this event as soon as the link is ready. Completing this checkout saves the card and fires trial.started; the customer is not charged until the trial ends. Paid (non-trial) checkouts fire checkout.ready instead. Use the checkoutUrl and trialDays to drive your own “start your X-day trial” messaging.

Body

application/json
id
string
required
event
string
required
Allowed value: "trial.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.