Pricing preview

Pricing previews are calculated totals for prices.

Paddle Checkout automatically shows the correct prices for a customer based on their location, including localized prices and taxes for their country or region.

You can use the preview prices operation to calculate prices in the same way Paddle Checkout does to show localized prices on a pricing page or other page in your app.

Paddle responds with a pricing preview object. This holds calculated totals for prices, including discounts, taxes, and currency conversion.

As well as returning totals in the lowest denomination for a currency, pricing previews contain formatted totals that include the currency symbol and decimal separator.

Attributes

customer_idstring or null

Paddle ID of the customer that this preview is for, prefixed with ctm_.

address_idstring or null

Paddle ID of the address that this preview is for, prefixed with add_. Send one of address_id, customer_ip_address, or the address object when previewing.

business_idstring or null

Paddle ID of the business that this preview is for, prefixed with biz_.

currency_codestring

Supported three-letter ISO 4217 currency code.

discount_idstring or null

Paddle ID of the discount applied to this preview, prefixed with dsc_.

addressobject or null

Address for this preview. Send one of address_id, customer_ip_address, or the address object when previewing.

postal_codestring or null

ZIP or postal code of this address. Include for more accurate tax calculations.

country_codestring

Supported two-letter ISO 3166-1 alpha-2 country code for this address.

customer_ip_addressstring or null

IP address for this transaction preview. Send one of address_id, customer_ip_address, or the address object when previewing.

itemsarray[object]

List of items to preview price calculations for.

price_idstring

Paddle ID for the price to add to this transaction, prefixed with pri_.

quantityinteger

Quantity of the item to preview.

detailsobject

Calculated totals for a price preview, including discounts, tax, and currency conversion.

line_itemsarray[object]

Information about line items for this preview. Includes totals calculated by Paddle. Considered the source of truth for line item totals.

available_payment_methodsarray[string]

List of available payment methods for Paddle Checkout given the price and location information passed.

Preview prices

posthttps://api.paddle.com/pricing-preview