List Subscriptions
stripe.list_subscriptions
ActionBusiness appsconnection required
Calls the Stripe API with the connection's secret key.
List Stripe subscriptions, newest first, with optional filters.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Stripe
- Secret shape
- the Stripe secret key (sk_...)
- Resolved by
- config.connection_id, else node.connection_id
Configuration
8 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 |
|---|---|---|---|---|---|
customer Return only subscriptions of this customer (cus_...). | string | No | — | — | — |
status Return only subscriptions in this state. Stripe returns active, trialing and past_due when you leave it blank. | string | No | — | one of "active", "past_due", "unpaid", "canceled", "incomplete", "incomplete_expired", "trialing", "paused", "ended", "all" | — |
price_id Return only subscriptions containing this price (price_...). | string | No | — | — | — |
limit How many objects to return, 1-100. Stripe defaults to 10. | number | No | 10 | 1–100 | — |
starting_after Cursor: return the page after this object id, for walking forward. | string | No | — | — | — |
ending_before Cursor: return the page before this object id, for walking backward. | string | No | — | — | — |
created_after Only objects created at or after this Unix timestamp, in seconds. | number | No | — | ≥ 0 | — |
created_before Only objects created at or before this Unix timestamp, in seconds. | number | No | — | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 10
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
subscriptions[].id The subscription id (sub_...). | string | — |
subscriptions[].status One of incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid or paused. | string | — |
subscriptions[].customer The customer this subscription bills. | string | — |
subscriptions[].currency Three-letter lowercase ISO currency code. | string | — |
subscriptions[].collection_method charge_automatically or send_invoice. | string | — |
subscriptions[].cancel_at_period_end True when it stops at the end of the period. | boolean | — |
subscriptions[].canceled_at When it was cancelled, Unix seconds, or null. | number | — |
subscriptions[].start_date When the subscription started, Unix seconds. | number | — |
subscriptions[].trial_end When the trial ends, Unix seconds, or null. | number | — |
subscriptions[].latest_invoice The most recent invoice id, or null. | string | — |
subscriptions[].default_payment_method The payment method it charges, or null. | string | — |
subscriptions[].created Creation time, as a Unix timestamp in seconds. | number | — |
subscriptions[].metadata The key/value pairs stored on the subscription. | object | — |
count How many objects this page returned. | number | — |
has_more True when Stripe has a further page to fetch. | boolean | — |
{
"count": 0,
"has_more": false,
"subscriptions": [
{
"cancel_at_period_end": false,
"canceled_at": 0,
"collection_method": "",
"created": 0,
"currency": "",
"customer": "",
"default_payment_method": "",
"id": "",
"latest_invoice": "",
"metadata": {},
"start_date": 0,
"status": "",
"trial_end": 0
}
]
}See List Subscriptions run in a workflow.
In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.