Checkout Events
As a part of the Paddle.Setup()
call, you can pass an eventCallback
parameter. This function is called for every Paddle checkout event, allowing you trigger behaviors based on user interactions with Paddle.
Unlike the Success
and Close
checkout parameter callbacks, the eventCallback
is non-blocking and occurs in the background, letting Paddle.js and the checkout continue with its typical functionality.
preparing...
List of events
Event Type | Description |
---|---|
Checkout.Loaded | Checkout has been initialized on the page |
Checkout.Customer.Details | User lands on the screen to enter their email and location details |
Checkout.Payment.Selection | User lands on the screen to select payment method |
Checkout.Payment.Selected | User selected a payment method |
Checkout.Complete | Checkout has been completed successfully. This is equivalent to when the "successCallback" checkout parameter is fired here. |
Checkout.Close | Checkout has been closed on the page. This is equivalent to when the "closeCallback" checkout parameter is fired here. |
Checkout.User.Subscribed | User has opted into/out of marketing emails in the checkout |
Checkout.Quantity.Change | User has changed the quantity in the checkout |
Checkout.CountryChanged | User has changed the country |
Checkout.Login | User has proceeded past the email checkout step |
Checkout.Logout | User selected 'Not you? Change' in bottom right of checkout |
Checkout.PaymentMethodSelected | Payment method has been selected |
Checkout.Coupon.Add | User clicked 'Add Coupon' |
Checkout.Coupon.Submit | User has submitted a coupon |
Checkout.Coupon.Cancel | User has cancelled the coupon page |
Checkout.Coupon.Applied | Valid coupon applied to purchase |
Checkout.Coupon.Remove | Coupon has been removed |
Checkout.Error | Any generic checkout error, like an invalid VAT number or payment failure |
Checkout.Failed | Checkout failed to load because the user is in a sanctioned country. |
Checkout.Location.Submit | User proceeded past the location page |
Checkout.Language.Change | Language has been changed in the bottom right |
Checkout.Vat.Add | User clicked 'Add VAT Number' |
Checkout.Vat.Cancel | VAT screen cancelled |
Checkout.Vat.Submit | VAT number was submitted |
Checkout.Vat.Applied | VAT number was accepted and applied |
Checkout.Vat.Remove | VAT number was removed |
Checkout.WireTransfer.Complete | User completed a checkout with Wire Transfer as the selected payment type. Always fired with Checkout.OfflinePayment.DetailsComplete . |
Checkout.OfflinePayment.DetailsComplete | User has completed a checkout and selected an offline payment type (in this scenario, any details that the user needs to make their payment offline, are displayed). |
Checkout.PaymentComplete | Payment has been completed successfully. Check if the payment has been flagged for manual fraud review in the eventData.flagged property, which returns a boolean value of true or false |
Checkout.PaymentMethodChange | User has selected "Change Payment Method" when on the payment screen |
Checkout.WireTransfer.PaymentMethodChange | User has selected "Change Payment Method" when on the Wire Transfer screen |
Try logging event data to the console to view the full range of values returned with each event.