Archive Customer
paddle.archive_customer
ActionBusiness appsconnection required
Calls the Paddle API with the connection's credentials.
Retire a customer so they can no longer be billed.
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
1 field, 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 |
|---|---|---|---|---|---|
customer_id The customer id, prefixed ctm_. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
archived True once Paddle accepted the status change. | boolean | — |
customer_id The customer that was archived. | string | — |
customer The customer record as it now stands. | object | — |
{
"archived": false,
"customer": {},
"customer_id": ""
}Notes
- Paddle never deletes catalog records; this sets status to archived, which is reversible by updating the record back to active.
See Archive Customer 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.