v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

List all payments for an invoice

When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.

get/v1/invoice_payments

Query parameters

OR
integer

Only return invoice payments that were created during the given date interval.

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

invoicestring

The identifier of the invoice whose payments to return.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

payment_intentstring
payment_recordstring
type'payment_intent' | 'payment_record' required

The payment details of the invoice payments to return.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

status'canceled' | 'open' | 'paid'

The status of the invoice payments to return.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.