Create Price
stripe.create_price
ActionBusiness appsconnection required
Calls the Stripe API with the connection's secret key.
Create a one-time or recurring price for an existing Stripe product.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Stripe
- Secret shape
- the Stripe secret key (sk_...)
- Resolved by
- config.connection_id, else node.connection_id
Configuration
11 fields, 3 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 The product this price belongs to (prod_...). | string | Yes | — | — | prod_NZKdYqrwEYx6iK |
currency Three-letter lowercase ISO currency code, such as usd or eur. | string | Yes | — | 3–3 characters | usd |
unit_amount Amount to charge per unit, in the currency's minor unit (1000 = 10.00 USD, and 1000 = 1000 JPY because the yen has no minor unit). 0 makes the price free. | number | Yes | — | ≥ 0 | 1000 |
recurring_interval Leave blank for a one-time price; set it to bill on a schedule. | string | No | — | one of "day", "week", "month", "year" | — |
recurring_interval_count How many intervals between billings — 3 with 'month' bills quarterly. | number | Conditional | 1 | ≥ 1; only with recurring_interval | — |
nickname An internal name for this price, hidden from customers. | string | No | — | — | — |
lookup_key A stable key you can use to fetch this price later instead of its id. | string | No | — | ≤ 200 characters | — |
tax_behavior Whether the amount already includes tax. Once set to inclusive or exclusive it cannot be changed. | string | No | — | one of "inclusive", "exclusive", "unspecified" | — |
active Whether the price can be used for new purchases. Stripe defaults a new price to active. | boolean | No | — | — | — |
metadata Key/value pairs stored on the price and returned on every read. | object | No | — | — | — |
idempotency_key Overrides the key this node derives from the step. Set it to a business identifier (an order id, say) when the same write must not repeat across runs; leave it blank and a retry of this step reuses the step's own key. | string | No | — | ≤ 255 characters | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"currency": "usd",
"product": "prod_NZKdYqrwEYx6iK",
"recurring_interval_count": 1,
"unit_amount": 1000
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The price id (price_...). | string | — |
product The product this price belongs to (prod_...). | string | — |
active True when the price can be used for new purchases. | boolean | — |
currency Three-letter lowercase ISO currency code. | string | — |
unit_amount Amount per unit, in the currency's minor unit. | number | — |
nickname The internal name of the price, or null. | string | — |
type one_time or recurring. | string | — |
recurring_interval day, week, month or year for a recurring price. | string | — |
recurring_interval_count How many intervals between billings. | number | — |
lookup_key The lookup key used to fetch this price, or null. | string | — |
created Creation time, as a Unix timestamp in seconds. | number | — |
metadata The key/value pairs stored on the price. | object | — |
{
"active": false,
"created": 0,
"currency": "",
"id": "",
"lookup_key": "",
"metadata": {},
"nickname": "",
"product": "",
"recurring_interval": "",
"recurring_interval_count": 0,
"type": "",
"unit_amount": 0
}Notes
- A price cannot have its amount changed; create a new one instead.
See Create Price run in a workflow.
In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.