Paddle.Setup()

Use Paddle.Setup() to initialize Paddle.js and set default checkout settings. This is a required method, letting you:

• Set your Paddle seller ID
• Integrate with Retain
• Set settings that apply to all checkouts opened on a page
• Create event callbacks

You must call Paddle.Setup() and pass your seller ID to use Paddle Checkout. You can find your seller ID in Paddle > Developer Tools > Authentication.

You can pass settings for opened checkouts using either Paddle.Checkout.open() or Paddle.Setup(). Settings passed to Paddle.Setup() are default settings, applied to all checkouts opened on a page.

Paddle.js emits events for key actions as a customer moves through checkout. You can pass an eventCallback to Paddle.Setup() to call a function for every Paddle.js checkout event. This is typically used as part of an inline checkout integration for updating on-page elements, like items lists or breadcrumbs.

Retain

Paddle.js integrates with Retain, so you don't have to embed a separate Retain script in your app or website. Pass pwAuth and your Retain API key to initialize Retain. You can find your Retain API key in ProfitWell > Account Settings > Integrations > API keys/Dev Kit.

To use Retain Notifications, pass pwCustomer for logged-in customers, too. You can use either a Paddle ID of a customer entity or an email address.

See: Retain x Paddle.js

Parameters

Examples

1
2
3
1Paddle.Setup({
2  seller: 99999
3});

1
2
3
4
1Paddle.Setup({
2  seller: 99999,
3  pwAuth: '00000000000000000000000000000000'
4});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
1Paddle.Setup({
2  seller: 99999, // replace with your Paddle seller ID
3  pwAuth: '00000000000000000000000000000000', // replace with your Retain API key
4  checkout: {
5    settings: {
6      displayMode: "inline",
7      theme: "light",
8      locale: "en",
9      frameTarget: "checkout-container",
10      frameInitialHeight: "450",
11      frameStyle: "width: 100%; min-width: 312px; background-color: transparent; border: none;"
12    }
13  }
14});

1
2
3
4
5
6
7
8
9
10
11
1Paddle.Setup({
2  seller: 99999,
3  pwAuth: '00000000000000000000000000000000',
4  checkout: {
5    settings: {
6      displayMode: "overlay",
7      theme: "light",
8      locale: "en"
9    }
10  }
11});

1
2
3
4
5
6
7
1Paddle.Setup({
2  seller: 99999,
3  pwAuth: '00000000000000000000000000000000',
4  eventCallback: function(data) {
5    console.log(data);
6  }
7});

1
2
3
4
5
6
7
1Paddle.Setup({
2  seller: 99999,
3  pwAuth: '00000000000000000000000000000000',
4  pwCustomer: {
5    id: 'ctm_01gt25aq4b2zcfw12szwtjrbdt'
6  }
7});

1
2
3
4
5
6
7
1Paddle.Setup({
2  seller: 99999,
3  pwAuth: '00000000000000000000000000000000',
4  pwCustomer: {
5    email: 'weloveyourproduct@paddle.com'
6  }
7});

Related pages