Sample - Stripe API
GET/v1/invoices/{invoice}/lines

List an invoice's line items

Lists the line items belonging to a specific invoice. Use starting_after and ending_before with limit to paginate the results, and use expand to include additional fields inline.

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

5 parameters
invoicestringrequired
The identifier of the invoice whose line items to retrieve. Maximum 5,000 characters.
ending_beforestringoptional
Object ID that defines the end of the requested page; use it to retrieve the previous page of results.
expandarray<string>optional
Specifies response fields to expand; each expansion name can contain up to 5,000 characters.
limitintegeroptional
Maximum number of line items to return. Must be between 1 and 100, and defaults to 10 when omitted.
starting_afterstringoptional
Object ID that defines the start of the requested page; use it to retrieve the next page of results.

2 status codes
200Returns a paginated list of invoice line items in `data`, with `has_more`, the list object type, and the URL for accessing the list.
dataarray<InvoiceLineItem>required
Details about each object.
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.
defaultError response.
errorobjectrequired

Error handling

invoice must be an invoice identifier of no more than 5,000 characters. limit accepts values from 1 to 100, starting_after and ending_before must contain object IDs when used, and each expand value can contain up to 5,000 characters.