Pause Subscription
paddle.pause_subscription
ActionBusiness appsconnection required
Calls the Paddle API with the connection's credentials.
Pause billing on a subscription, optionally with a date to resume on.
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
4 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 | — | — | — |
effective_from immediately pauses now; Paddle defaults to next_billing_period. | string | No | — | one of "immediately", "next_billing_period" | — |
resume_at RFC 3339 date to resume on; leave empty to pause indefinitely. | string | No | — | — | — |
on_resume Whether resuming continues the old billing period or starts a new one. | string | No | — | one of "continue_existing_billing_period", "start_new_billing_period" | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
subscription The subscription as Paddle returned it after the call. | object | — |
subscription_id The subscription that was acted on. | string | — |
status The subscription's status now — not necessarily its end state. | string | — |
action The change requested: cancel, pause or resume. | string | — |
applied_immediately False when Paddle only scheduled the change for the next billing period. | boolean | — |
scheduled_change Paddle's pending change record, or null when applied. | object | — |
effective_at RFC 3339 date a scheduled change takes effect, else empty. | string | — |
{
"action": "",
"applied_immediately": false,
"effective_at": "",
"scheduled_change": {},
"status": "",
"subscription": {},
"subscription_id": ""
}Notes
- With next_billing_period Paddle records a scheduled_change rather than pausing at once — applied_immediately and effective_at say which happened.
See Pause 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.