Paddle.js events

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.Initialize() 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.

Attributes

namestring

Name of this event, in the format entity.event_type.

dataobject

Event payload.

idstring

Unique Paddle ID for this checkout, prefixed with che_.

transaction_idstring

Unique Paddle ID for the transaction related to this checkout, prefixed with txn_.

statusstring

Status of this checkout.

custom_dataobject or null

Key-value pairs of custom data. Must be valid JSON and contain at least one key.

currency_codestring

Supported three-letter ISO 4217 currency code for this checkout.

customerobject

Information about the customer on this checkout.

itemsarray[object]

Items to bill for.

totalsobject

Financial breakdown of the total for this checkout, calculated by Paddle.

recurring_totalsobject

Financial breakdown of the recurring total for this checkout, calculated by Paddle. Only included where there are recurring items.

paymentobject

Information about the payment details used on this checkout.

settingsobject

Checkout settings.

discountobject or null

Information about the discount applied to this checkout. Only included when a discount is applied.

List of events

Event name	Details
`checkout.loaded`	Checkout created and loaded on the page.
`checkout.closed`	Checkout closed on the page.
`checkout.completed`	Checkout completed successfully.
`checkout.items.updated`	Item updated on the checkout. For example, a quantity change.
`checkout.items.removed`	Item removed from the checkout.
`checkout.customer.created`	Customer created.
`checkout.customer.updated`	Customer information updated. This includes business and address information.
`checkout.customer.removed`	Customer removed from the checkout, e.g. they logged out.
`checkout.payment.selected`	Payment method selected.
`checkout.payment.initiated`	Customer attempted payment using the selected payment method.
`checkout.payment.failed`	Payment attempt failed.
`checkout.discount.applied`	Discount applied to the checkout.
`checkout.discount.removed`	Discount removed from the checkout.
`checkout.warning`	Warning occurred on the checkout.
`checkout.error`	Error occurred on the checkout.

Build an inline checkout

Include and initialize Paddle.js

Paddle.js events

Attributes

List of events

Related pages

Sign up to get notified when our API evolves