Sample - Stripe API
GET/v1/invoices

List invoices

Lists invoices ordered by creation date, with the newest invoices first. Filter by customer, subscription, collection method, due date, creation date, or invoice status, and use starting_after or ending_before to paginate the results.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

11 parameters
collection_methodstringoptional
Filter invoices by collection method: `charge_automatically` or `send_invoice`.
Allowed:charge_automaticallysend_invoice
createdobjectoptional
Restrict results to invoices created at a Unix timestamp or within a range defined by `gt`, `gte`, `lt`, or `lte`.
customerstringoptional
The customer identifier whose invoices to return.
customer_accountstringoptional
The account identifier representing the customer whose invoices to return.
due_dateobjectoptional
Restrict results to invoices due at a Unix timestamp or within a range defined by `gt`, `gte`, `lt`, or `lte`.
ending_beforestringoptional
An object ID cursor that defines the end of the requested page when retrieving previous results.
expandarray<string>optional
Fields to expand in the response.
limitintegeroptional
The maximum number of invoices to return. Must be between 1 and 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that defines the start of the requested page when retrieving subsequent results.
statusstringoptional
Filter invoices by status: `draft`, `open`, `paid`, `uncollectible`, or `void`.
Allowed:draftopenpaiduncollectiblevoid
subscriptionstringoptional
The subscription identifier whose invoices to return.

2 status codes
200Returns a list object containing invoices, the `has_more` pagination flag, the object type, and the list URL.
dataarray<Invoice>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the request cannot be processed; the response contains an API error object with a required `type` field.
errorobjectrequired

Error handling

collection_method must be charge_automatically or send_invoice, and status must be one of draft, open, paid, uncollectible, or void. limit must be between 1 and 100 and defaults to 10 when omitted; created and due_date accept a Unix timestamp or a range using gt, gte, lt, or lte.