Docs

Paddle.Update()

Use to update values passed to Paddle.js during initialization.

Use Paddle.Update() to update values sent to Paddle.js during initialization. This is typically used when working with single page applications to pass an updated customer to pwCustomer when a customer is identified.

You must call Paddle.Initialize() before calling Paddle.Update(). Use the Paddle.Initialized flag to determine whether you need to call Paddle.Initialize() or Paddle.Update().

Parameters

pwCustomerobject | null
Identifier for a logged-in customer for Paddle Retain. Pass an empty object if you don't have a logged-in customer. Paddle Retain is only loaded for live accounts.
idstring
Paddle ID of a customer entity, prefixed ctm_. Only customer IDs are accepted. Don't pass subscription IDs, other Paddle IDs, or your own internal identifiers for a customer.
eventCallback(event: EventData) => void | null
Function to call for Paddle.js events.

Examples

This example passes a new pwCustomer to Paddle.js using Paddle.Update().

JavaScript
Paddle.Update({
pwCustomer: {
id: "ctm_01gt25aq4b2zcfw12szwtjrbdt",
},
});
TypeScript
import { initializePaddle } from "@paddle/paddle-js";
const paddle = await initializePaddle({
pwCustomer: {
id: "ctm_01gt25aq4b2zcfw12szwtjrbdt",
},
});

This example checks if Paddle is initialized using the Paddle.Initialized flag, then calls Paddle.Update() to set pwCustomer if not initialized.

JavaScript
if (Paddle.Initialized) {
Paddle.Update({
pwCustomer: {
id: "ctm_01gt25aq4b2zcfw12szwtjrbdt",
},
});
} else {
Paddle.Initialize({
token: "live_7d279f61a3499fed520f7cd8c08",
checkout: {
displayMode: "overlay",
theme: "dark",
locale: "en",
},
pwCustomer: {},
});
}
TypeScript
import { initializePaddle } from "@paddle/paddle-js";
if (window.Paddle?.Initialized) {
await initializePaddle({
pwCustomer: {
id: "ctm_01gt25aq4b2zcfw12szwtjrbdt",
},
});
} else {
await initializePaddle({
token: "live_7d279f61a3499fed520f7cd8c08",
checkout: {
settings: {
displayMode: "overlay",
theme: "dark",
locale: "en",
},
},
pwCustomer: {},
});
}

Was this page helpful?