Paddle.js emits events as part of the checkout journey. Use events to update elements in your frontend for inline checkout, or for analytics purposes.
As your customer moves through the checkout, Paddle.js emits events for key actions like:
- When the checkout is opened, closed, or completed
- When customer information is added, updated, or removed
- When items are added, removed, or updated
- When payments are attempted and outcomes of payment attempts
- When discounts are added or removed
You can pass an
eventCallback parameter as part of the
Paddle.Setup() method to trigger behaviors based on customer interactions with your checkout. You'll typically use this to show and update on-page information when building an inline checkout.
Name of this event, in the format
Unique Paddle ID for this checkout, prefixed with
Unique Paddle ID for the transaction related to this checkout, prefixed with
Status of this checkout. Mirrors the status of the related transaction.
Key-value pairs of custom data. Must be valid JSON and contain at least one key.
Supported three-letter ISO 4217 currency code for this checkout.
Information about the customer on this checkout.
Items to bill for.
Financial breakdown of the total for this checkout, calculated by Paddle.
Financial breakdown of the recurring total for this checkout, calculated by Paddle. Only included where there are recurring items.
Information about the payment details used on this checkout.
Information about the discount applied to this checkout. Only included when a discount is applied.
|Checkout created and loaded on the page.|
|Checkout closed on the page.|
|Checkout completed successfully.|
|Item updated on the checkout. For example, a quantity change.|
|Item removed from the checkout.|
|Customer information updated. This includes business and address information.|
|Customer removed from the checkout, e.g. they logged out.|
|Payment method selected.|
|Customer attempted payment using the selected payment method.|
|Payment attempt failed.|
|Discount applied to the checkout.|
|Discount removed from the checkout.|
|Error occurred on the checkout.|