Sample - Stripe API
GET/v1/invoice_payments

List payments for invoices

Lists payments associated with invoices. Filter by invoice, payment type, payment status, or creation time, and use cursor parameters with limit to retrieve the full paginated payment history.

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

8 parameters
createdobjectoptional
Filter invoice payments by creation time using a Unix timestamp or a range object with `gt`, `gte`, `lt`, or `lte`.
ending_beforestringoptional
Cursor that identifies the object before the page you want to retrieve. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in each response object. Each value must be no longer than 5000 characters.
invoicestringoptional
Filter payments by the invoice identifier. Maximum 5000 characters.
limitintegeroptional
Maximum number of invoice payments to return. Must be between 1 and 100 and defaults to 10 when omitted.
paymentobjectoptional
Filter by associated payment details. `type` is required and must be `payment_intent` or `payment_record`; provide the corresponding payment identifier when applicable.
starting_afterstringoptional
Cursor that identifies the object after the page you want to retrieve. Maximum 5000 characters.
statusstringoptional
Filter payments by status: `canceled`, `open`, or `paid`.
Allowed:canceledopenpaid

2 status codes
200Returns a paginated list object containing invoice payment records, including requested and paid amounts, currency, invoice, associated payment, status, and transition timestamps.
dataarray<InvoicePayment>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, ending_before, and starting_after must be no longer than 5000 characters. limit accepts between 1 and 100 payments and defaults to 10; payment.type must be payment_intent or payment_record, and status must be canceled, open, or paid.