⌘ K

Paddle.js

Integrate Paddle and Retain in your app or website frontend with Paddle.js.

Illustration of a payment being accepted.

Featured

Open your first Paddle Checkout in five minutes.

Paddle.js methods

Explore the methods available in Paddle.js to interact with checkouts and pricing pages.

Paddle.js events

Use an event callback to show and update on-page information based on events emitted by Paddle.js.

Common tasks

Code sample for opening a Paddle checkout.

Open a checkout

Checkout.open()

Code sample for previewing localized prices.

Show localized prices

PricePreview()

Code sample for handling checkout events.

React to checkout events

Initialize({ eventCallback })

Methods

Paddle.Initialize()
Use to initialize Paddle.js and Retain. This is required.
Paddle.Update()
Use to update values passed to Paddle.js during initialization.
Paddle.Checkout.open()
Use to open a checkout with settings, items, and customer information.
Paddle.Checkout.updateCheckout()
Use to update an open checkout.
Paddle.Checkout.close()
Use to close an opened checkout.
Paddle.PricePreview()
Use to preview localized prices given location information supplied.
Paddle.TransactionPreview()
Use to generate a transaction preview for prices and location information supplied.
Paddle.Retain.initCancellationFlow()
Use to start a Paddle Retain cancellation flow for a subscription.

Events

checkout.loaded
Emitted when a checkout is created and loaded on the page.
checkout.completed
Emitted when a checkout is completed successfully.
checkout.error
Emitted when an error occurs on a checkout.
checkout.warning
Emitted when a warning occurs on a checkout.
checkout.updated
Emitted when a checkout is updated using one of the checkout update methods.
checkout.customer.created
Emitted when a customer is created as part of checkout.
checkout.items.removed
Emitted when an item is removed from a checkout.
checkout.payment.initiated
Emitted when an attempt to take payment is initiated.