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
- https://api.stripe.com/
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. |
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. |
status |
String | No |
The status of the invoice payments to return. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.