Checkout Events

Paddle.js Event Callback

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 will fire in the background, allowing Paddle.js and the checkout to continue with its typical functionality.

Paddle.Setup({
  vendor: 12345,
  eventCallback: function(data) {
    // The data.event will specify the event type
    if (data.event === "Checkout.Complete") {
      console.log(data.eventData); // Data specifics on the event
    }
    else if (data.event === "Checkout.Close") {
      console.log(data.eventData); // Data specifics on the event
    }
  }
});

List of Events

Event Type Description
Checkout.Loaded Checkout has been initialized on the page
Checkout.Close Checkout has been closed on the page. This is equivalent to when the “closeCallback” checkout parameter is fired here.
Checkout.Complete Checkout has been completed successfully. This is equivalent to when the “successCallback” 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.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
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 Wire transfer details have been completed
Checkout.PaymentComplete Payment has been completed successfully. Check if the payment has been flagged for manual fraud review in eventData.flagged

Try logging event data to the console to view the full range of values returned with each event.