GET
/v1/invoiceitemsList invoice items
Lists invoice items ordered by creation date, with the newest items first. Filter by customer, customer_account, invoice, pending, or created, and use starting_after or ending_before to paginate the results.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
createdobjectoptional
Restrict results to invoice items created at a Unix timestamp or within a range defined by `gt`, `gte`, `lt`, or `lte`.
customerstringoptional
The customer identifier whose invoice items to return. Defaults to all invoice items when omitted.
customer_accountstringoptional
The account identifier representing the customer whose invoice items to return. Defaults to all invoice items when omitted.
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.
invoicestringoptional
The invoice identifier whose invoice items to return. If omitted, invoice items for all invoices are returned.
limitintegeroptional
The maximum number of invoice items to return. Must be between 1 and 100. Defaults to 10 when omitted.
pendingbooleanoptional
Filter by attachment state: `true` returns pending items and `false` returns items already attached to invoices. No filter is applied when omitted.
starting_afterstringoptional
An object ID cursor that defines the start of the requested page when retrieving subsequent results.
200Returns a list object containing invoice items, the `has_more` pagination flag, the object type, and the list URL.
dataarray<InvoiceItem>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`.
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
limit must be between 1 and 100 and defaults to 10 when omitted. created must be a Unix timestamp or a range using gt, gte, lt, or lte; pending accepts a boolean, and cursor values must be no longer than 5,000 characters.