Pause Subscription
chargebee.pause_subscription
ActionCRM & salesconnection required
Calls the Chargebee API with the connection's credentials.
Pause a subscription now, at term end, or on a specific date.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Chargebee
- Secret shape
- the site API key: the raw string, {"api_key": "…"}, or the HTTP Basic pair {"username": "<api key>", "password": ""}
- Config it needs
- site, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 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 Chargebee subscription id. | string | Yes | — | — | — |
pause_option When the pause takes effect. 'specific_date' uses pause_date; 'billing_cycles' resumes automatically after the number of cycles set in extra.skip_billing_cycles. Leave empty to take Chargebee's default. | string | No | — | one of "immediately", "end_of_term", "specific_date", "billing_cycles" | — |
pause_date The Unix timestamp in seconds (UTC) to pause on, when the option is a specific date. | number | Conditional | — | ≥ 0; only with pause_option | — |
resume_date The Unix timestamp in seconds (UTC) to resume on automatically. Leave empty to resume the subscription by hand later. | number | No | — | ≥ 0 | — |
extra Any other parameter documented for this endpoint, merged into the request body. Nested objects and arrays are form-encoded the way Chargebee documents them, e.g. {"billing_address": {"city": "Walnut"}}. | object | No | — | — | {"billing_address":{"city":"Walnut"}} |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"extra": {
"billing_address": {
"city": "Walnut"
}
}
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
subscription The subscription resource as Chargebee returned it. | object | — |
customer The customer the subscription belongs to. | object | — |
card The card on the customer, when one is on file. | object | — |
invoice The invoice this change raised, present only when Chargebee billed immediately. | object | — |
unbilled_charges Charges the change created but did not invoice yet; an empty or absent list means everything was billed. | array | — |
credit_notes Credit notes Chargebee raised for the part of the term that was not used. | array | — |
{
"card": {},
"credit_notes": [],
"customer": {},
"invoice": {},
"subscription": {},
"unbilled_charges": []
}Notes
- The Chargebee site and API key come from the connection; every path below is relative to https://<site>.chargebee.com/api/v2.
- POST /subscriptions/{subscription-id}/pause
See Pause Subscription run in a workflow.
In a technical demo we add the Chargebee connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.