Get Subscription
paddle.get_subscription
ActionBusiness appsconnection required
Calls the Paddle API with the connection's credentials.
Fetch one subscription by its Paddle id.
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
2 fields, 1 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 |
|---|---|---|---|---|---|
subscription_id The subscription id, prefixed sub_. | string | Yes | — | — | — |
include Related entities to embed, such as next_transaction. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The subscription id, prefixed sub_. | string | — |
status active, trialing, paused, past_due or canceled. | string | — |
customer_id The customer this subscription bills. | string | — |
currency_code Three-letter currency this subscription bills in. | string | — |
collection_mode automatic when Paddle charges, manual for an invoice. | string | — |
billing_cycle interval and frequency of the recurring charge. | object | — |
current_billing_period starts_at and ends_at of the period being billed. | object | — |
next_billed_at RFC 3339 date of the next charge, or null. | string | — |
scheduled_change A pending cancel, pause or resume, or null. | object | — |
items The prices on the subscription and their quantities. | array | — |
{
"billing_cycle": {},
"collection_mode": "",
"currency_code": "",
"current_billing_period": {},
"customer_id": "",
"id": "",
"items": [],
"next_billed_at": "",
"scheduled_change": {},
"status": ""
}See Get Subscription 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.