GET /v1/invoice_payments

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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
limit Integer No

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

invoice String No

The identifier of the invoice whose payments to return.

starting_after 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.

expand[] Array No

Specifies which fields in the response should be expanded.

payment Object No

The payment details of the invoice payments to return.

ending_before 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.

status String No

The status of the invoice payments to return.

Possible values:

  • "open"
  • "paid"
  • "canceled"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.