Create Price
paddle.create_price
ActionBusiness appsconnection required
Calls the Paddle API with the connection's credentials.
Create a price for a product — a recurring plan when a billing cycle is given, a one-time price when it is not.
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
14 fields, 4 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
product_id The product this price belongs to, prefixed pro_. | string | Yes | — | — | — |
description Internal description of the price, 2 to 500 characters. | string | Yes | — | ≤ 500 characters | — |
amount Amount in the currency's lowest denomination, so 1000 means 10.00. | string | Yes | — | — | — |
currency_code Three-letter ISO 4217 currency, such as USD. | string | Yes | — | 3–3 characters | — |
name Customer-facing name shown at checkout, up to 150 characters. | string | No | — | ≤ 150 characters | — |
type standard for a catalogue price, custom for a one-off one. | string | No | — | one of "standard", "custom" | — |
billing_interval Unit of the recurring cycle; leave empty for a one-time price. | string | No | — | one of "day", "week", "month", "year" | — |
billing_frequency How many intervals are in one billing cycle, such as 3 months. | number | Conditional | — | ≥ 1; only with billing_interval | 1 |
trial_interval Unit of the free trial; only for a recurring price, so set a billing cycle. | string | No | — | one of "day", "week", "month", "year" | — |
trial_frequency How many trial intervals to give before the first charge. | number | Conditional | — | ≥ 1; only with trial_interval | 7 |
tax_mode How tax is applied; defaults to your account setting. | string | No | — | one of "account_setting", "external", "internal", "location" | — |
quantity_minimum Fewest units a customer may buy of this price. | number | No | — | ≥ 1 | — |
quantity_maximum Most units a customer may buy of this price. | number | No | — | ≥ 1 | — |
custom_data Your own key-value data to store on the price (JSON). | object | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"billing_frequency": 1,
"trial_frequency": 7
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
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 Create 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.