List Invoices
stripe.list_invoices
ActionBusiness appsconnection required
Calls the Stripe API with the connection's secret key.
List Stripe invoices, 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 invoices for this customer (cus_...). | string | No | — | — | — |
status Return only invoices in this state. | string | No | — | one of "draft", "open", "paid", "uncollectible", "void" | — |
subscription Return only invoices for this subscription (sub_...). | 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 |
|---|---|---|
invoices[].id The invoice id (in_...). | string | — |
invoices[].number The customer-facing invoice number, once finalised. | string | — |
invoices[].status One of draft, open, paid, uncollectible or void. | string | — |
invoices[].customer The customer being billed. | string | — |
invoices[].currency Three-letter lowercase ISO currency code. | string | — |
invoices[].subtotal Total before discounts and tax, in the minor unit. | number | — |
invoices[].total Total after discounts and tax, in the minor unit. | number | — |
invoices[].amount_due Amount due on this invoice, in the minor unit. | number | — |
invoices[].amount_paid Amount paid so far, in the minor unit. | number | — |
invoices[].amount_remaining Amount still owed, in the minor unit. | number | — |
invoices[].collection_method charge_automatically or send_invoice. | string | — |
invoices[].due_date When payment is due, Unix seconds, or null. | number | — |
invoices[].hosted_invoice_url Stripe-hosted page where the customer can pay. | string | — |
invoices[].invoice_pdf Link to the invoice PDF, once finalised. | string | — |
invoices[].created Creation time, as a Unix timestamp in seconds. | number | — |
invoices[].metadata The key/value pairs stored on the invoice. | 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,
"invoices": [
{
"amount_due": 0,
"amount_paid": 0,
"amount_remaining": 0,
"collection_method": "",
"created": 0,
"currency": "",
"customer": "",
"due_date": 0,
"hosted_invoice_url": "",
"id": "",
"invoice_pdf": "",
"metadata": {},
"number": "",
"status": "",
"subtotal": 0,
"total": 0
}
]
}See List Invoices 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.