Update Price

paddle.update_price
ActionBusiness appsconnection required

Calls the Paddle API with the connection's credentials.

Change the description, name, amount, tax mode or status of a price.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Paddle
Secret shape
the Paddle API key (pdl_…), or {"api_key": "…"}
Config it needs
environment, base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

8 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
price_id
The price id, prefixed pri_.
stringYes———
description
New internal description, up to 500 characters.
stringNo—≤ 500 characters—
name
New customer-facing name, up to 150 characters.
stringNo—≤ 150 charactersPro plan (monthly)
amount
New amount in the lowest denomination; send currency_code with it.
stringNo———
currency_code
Three-letter currency for the new amount.
stringConditional—3–3 characters; only with amount—
tax_mode
How tax is applied to this price.
stringNo—one of "account_setting", "external", "internal", "location"—
status
Set to archived to retire the price, or active to restore it.
stringNo—one of "active", "archived"—
custom_data
Replacement key-value data for the price (JSON).
objectNo———
  • At least one of name, description, amount, tax_mode, status, custom_data must be set.

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "name": "Pro plan (monthly)"
}

Output

One shape.

result

FieldTypeExample
id
The price id, prefixed pri_.
string—
product_id
The product this price belongs to.
string—
name
Customer-facing name of this price.
string—
description
Internal description of this price.
string—
type
standard for a catalog price, custom otherwise.
string—
unit_price
amount (lowest denomination) and currency_code.
object—
billing_cycle
interval and frequency, or null for a one-time price.
object—
trial_period
interval and frequency of the trial, or null.
object—
quantity
The minimum and maximum quantity a customer may buy.
object—
tax_mode
How tax is applied to this price.
string—
status
active or archived.
string—
{
  "billing_cycle": {},
  "description": "",
  "id": "",
  "name": "",
  "product_id": "",
  "quantity": {},
  "status": "",
  "tax_mode": "",
  "trial_period": {},
  "type": "",
  "unit_price": {}
}

See Update Price run in a workflow.

In a technical demo we add the Paddle connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.