Docs

Paddle.Checkout.updateItems()

Use to dynamically update the items list of an open checkout.

Use Paddle.Checkout.updateItems() to dynamically update the items list for an open checkout.

Typically used with inline checkout to update quantities or add addons to the checkout.

To use this method, a checkout should already be opened. Use the Paddle.Checkout.open() method to open a checkout.

Pass an array of objects, where each object contains a priceId and quantity property. priceId should be a Paddle ID of a price entity.

Paddle expects the complete list of items that you want to be on the checkout — including existing items. If you don't include an existing item, it's removed from the checkout. To learn more, see Work with lists

Parameters

itemsarray
List of items for this checkout.
priceIdstring
Example: pri_01gm81eqze2vmmvhpjg13bfeqg
Paddle ID of the price for this item.
quantityinteger | null
Example: 1
Quantity for this line item.

Example

This example passes an array called itemsList to Paddle.Checkout.updateItems().

If successful, the items on the opened checkout are updated.

JavaScript
var itemsList = [
{
priceId: "pri_01gm81eqze2vmmvhpjg13bfeqg",
quantity: 1,
},
{
priceId: "pri_01gm82kny0ad1tk358gxmsq87m",
quantity: 1,
},
{
priceId: "pri_01gm82v81g69n9hdb0v9sw6j40",
quantity: 1,
},
];
Paddle.Checkout.updateItems(itemsList);
TypeScript
import { initializePaddle } from "@paddle/paddle-js";
const paddle = await initializePaddle({
token: "live_7d279f61a3499fed520f7cd8c08",
});
const itemsList = [
{
priceId: "pri_01gm81eqze2vmmvhpjg13bfeqg",
quantity: 1,
},
{
priceId: "pri_01gm82kny0ad1tk358gxmsq87m",
quantity: 1,
},
{
priceId: "pri_01gm82v81g69n9hdb0v9sw6j40",
quantity: 1,
},
];
paddle?.Checkout.updateItems(itemsList);

To learn more, see Pass or update checkout items

Events

checkout.items.updated Emitted when an item is updated on a checkout.
checkout.items.removed Emitted when an item is removed from a checkout.

Was this page helpful?