Create a price
Creates a new price.
Prices describe how you charge for products. You must include a product_id
in your request to relate this price to a product.
If you omit the quantity
object, Paddle automatically sets a minimum of 1
and a maximum of 100
for you. This means the most units that a customer can buy is 100. Set a quantity if you'd like to offer a different amount.
If successful, your response includes a copy of the new price entity.
Request Body
Internal description for this price, not shown to customers. Typically notes for your team.
Paddle ID for the product that this price is for, prefixed with pro_
.
Base price. This price applies to all customers, except for customers located in countries where you have unit_price_overrides
.
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.
Supported three-letter ISO 4217 currency code.
Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app. If omitted, defaults to standard
.
Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.
How often this price should be charged. null
if price is non-recurring (one-time). If omitted, defaults to null
.
Amount of time.
Unit of time.
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
. If omitted, defaults to null
.
Amount of time.
Unit of time.
How tax is calculated for this price. If omitted, defaults to account_setting
.
List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.
Supported two-letter ISO 3166-1 alpha-2 country code.
Override price. This price applies to customers located in the countries for this unit price override.
Limits on how many times the related product can be purchased at this price. Useful for discount campaigns. If omitted, defaults to 1-100.
Minimum quantity of the product related to this price that can be bought. Required if maximum
set.
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.
Your own structured key-value data.
Response
Represents a price entity.
Unique Paddle ID for this price, prefixed with pri_
.
Paddle ID for the product that this price is for, prefixed with pro_
.
Internal description for this price, not shown to customers. Typically notes for your team.
Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app.
Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.
How often this price should be charged. null
if price is non-recurring (one-time).
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
.
How tax is calculated for this price.
Base price. This price applies to all customers, except for customers located in countries where you have unit_price_overrides
.
List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.
Limits on how many times the related product can be purchased at this price. Useful for discount campaigns.
Whether this entity can be used in Paddle.
Your own structured key-value data.
Import information for this entity. null
if this entity is not imported.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
1234567891011121314151617181{
2 "description": "Monthly (per seat) with 14 day trial",
3 "name": "Monthly (per seat)",
4 "product_id": "pro_01htz88xpr0mm7b3ta2pjkr7w2",
5 "unit_price": {
6 "amount": "500",
7 "currency_code": "USD"
8 },
9 "billing_cycle": {
10 "interval": "month",
11 "frequency": 1
12 },
13 "trial_period": {
14 "interval": "day",
15 "frequency": 14
16 },
17 "tax_mode": "account_setting"
18}