Paddle Billing
Search

Update a price

Updates a price using its ID.

If successful, your response includes a copy of the updated price entity.

Path Parameters

price_idstringrequired

Paddle ID of the price entity to work with.

Request Body

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

frequencyintegerrequired

Amount of time.

intervalstringrequired

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.

frequencyintegerrequired

Amount of time.

intervalstringrequired

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.

amountstringrequired

Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents).

currency_codestringrequired

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]required

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

unit_priceobjectrequired

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.

minimumintegerrequired

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

maximumintegerrequired

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.

Response

dataobject

Represents a price entity.

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.

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.