get /v1/invoice_payments

List all payments for an invoice

GetInvoicePayments

<p>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.</p>

Parameters

Name In Type Required Description
created query object | integer no Only return invoice payments that were created during the given date interval.
ending_before query string no 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.
expand query string[] no Specifies which fields in the response should be expanded.
invoice query string no The identifier of the invoice whose payments to return.
limit query integer no A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment query object no The payment details of the invoice payments to return.
starting_after query string no 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 query string no The status of the invoice payments to return.

Request Body

application/x-www-form-urlencoded

Responses

200 Successful response.
default Error response.