Paddle Billing
Search

List prices

Returns a paginated list of prices. Use the query parameters to page through results.

By default, Paddle returns prices that are active. Use the status query parameter to return prices that are archived.

Use the include parameter to include the related product entity in the response.

Query Parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

idarray[string]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

includearray[string]

Include related entities in the response.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: billing_cycle.frequency, billing_cycle.interval, id, product_id, quantity.maximum, quantity.minimum, status, tax_mode, unit_price.amount, and unit_price.currency_code.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

product_idarray[string]

Return entities related to the specified product. Use a comma-separated list to specify multiple product IDs.

statusarray[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

recurringboolean

Determine whether returned entities are for recurring prices (true) or one-time prices (false).

typestring

Return items that match the specified type.

Response

dataarray[object]

Represents a price entity with included entities.

idstring

Unique Paddle ID for this price, prefixed with pri_.

product_idstring

Paddle ID for the product that this price is for, prefixed with pro_.

descriptionstring

Internal description for this price, not shown to customers. Typically notes for your team.

typestring

Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app.

namestring or null

Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.

billing_cycleobject or null

How often this price should be charged. null if price is non-recurring (one-time).

trial_periodobject or null

Trial period for the product related to this price. The billing cycle begins once the trial period is over. null for no trial period. Requires billing_cycle.

tax_modestring

How tax is calculated for this price.

unit_priceobject

Base price. This price applies to all customers, except for customers located in countries where you have unit_price_overrides.

unit_price_overridesarray[object]

List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.

quantityobject

Limits on how many times the related product can be purchased at this price. Useful for discount campaigns.

statusstring

Whether this entity can be used in Paddle.

custom_dataobject or null

Your own structured key-value data.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

productobject

Related product for this price. Returned when the include parameter is used with the product value.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.