Prices

Price entities describe how much and how often you charge for your products. They hold charging information.

Prices describe the way that you charge for products in your catalog. They're linked to your products using product IDs.

Price entities hold information like:

How much it costs.
What currency it's billed in.
Whether it's one-time or recurring.
How often it's billed, if recurring.
How long a trial period is, if any.

You can add as many prices as you like against a product — especially useful for subscription plans. For example, a "Premium plan" product might have an annual price and a monthly price.

For country-specific pricing, use price overrides rather than creating multiple prices. Price overrides let you override your base price with a custom price and currency for any country.

Add prices to checkouts, transactions, and subscriptions to bill for your products.

Get a step-by-step overview of how to create a product that's ready-to-sell, including prices and price overrides. See: Create products and prices

There's no delete operation for prices. Use the update price operation to archive prices when you no longer need them. See: Delete entities

Attributes

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).

frequencyinteger

Amount of time.

intervalstring

Unit of 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.

frequencyinteger

Amount of time.

intervalstring

Unit of time.

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.

amountstring

Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents). Although represented as a string, this value must be a valid integer.

currency_codestring

Supported three-letter ISO 4217 currency code.

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.

country_codesarray[string]

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

unit_priceobject

Override price. This price applies to customers located in the countries for this unit price override.

quantityobject

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

minimuminteger

Minimum quantity of the product related to this price that can be bought. Required if maximum set.

maximuminteger

Maximum quantity of the product related to this price that can be bought. Required if minimum set. Must be greater than or equal to the minimum value.

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.

imported_fromstring

Name of the platform where this entity was imported from.

external_idstring or null

Reference or identifier for this entity from the solution where it was imported from.

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.

List prices

gethttps://api.paddle.com/prices

Create a price

posthttps://api.paddle.com/prices

Get a price

gethttps://api.paddle.com/prices/{price_id}

Update a price

patchhttps://api.paddle.com/prices/{price_id}