List Subscriptions
chargebee.list_subscriptions
ActionCRM & salesconnection required
Calls the Chargebee API with the connection's credentials.
Read a page of subscriptions, with Chargebee's list filters and sorting.
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
6 fields, none 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 |
|---|---|---|---|---|---|
limit How many subscriptions to return in one page. Chargebee allows 1-100 and defaults to 10. | number | No | 10 | 1–100 | — |
offset Where the page starts. Pass the 'next_offset' returned by the previous call; leave it empty for the first page. | string | No | — | ≤ 1000 characters | — |
filters Chargebee list filters, either spelling the reference uses: {"status[in]": ["paid", "not_paid"]} or {"status": {"in": ["paid"]}}. A list value is sent as the JSON array the [in], [not_in] and [between] operators expect. | object | No | — | — | {"status[in]":["paid","not_paid"]} |
sort_by The attribute to sort on, for example 'created_at' or 'date'. Leave empty to keep Chargebee's own ordering. | string | No | — | — | — |
sort_order Sort direction, sent as Chargebee's sort_by[asc] or sort_by[desc]. | string | Conditional | asc | one of "asc", "desc"; only with sort_by | — |
include_deleted Include deleted subscriptions in the page; each carries 'deleted': true. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"filters": {
"status[in]": [
"paid",
"not_paid"
]
},
"include_deleted": false,
"limit": 10,
"sort_order": "asc"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The subscription objects on this page, in Chargebee's order. | array | — |
count How many rows this page actually contained. | number | — |
next_offset Pass this back as 'offset' to read the next page; empty on the last page. | string | — |
has_more True while Chargebee returned a next_offset. | boolean | — |
{
"count": 0,
"has_more": false,
"items": [],
"next_offset": ""
}Notes
- The Chargebee site and API key come from the connection; every path below is relative to https://<site>.chargebee.com/api/v2.
- GET /subscriptions
See List Subscriptions 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.