List subscription invoice payments
GEThttps://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices/:invoice_uuid/payments
Lists all invoice payments for a given invoice.
Request
Path Parameters
subscription_uuid UUIDrequired
The unique identifier of the subscription.
invoice_uuid UUIDrequired
The unique identifier of the invoice.
Query Parameters
page[offset] int64
Possible values: <= 10000
The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.
page[limit] int64
The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.
Responses
- 200
Success. Payments for the invoice are returned.
- application/json
- Schema
- Example (from schema)
Schema
data SubscriptionInvoicePayment[]
links object
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "subscription_invoice_payment",
"attributes": {
"success": true,
"pending": true,
"gateway": "elastic_path_payments_stripe",
"external_payment_id": "33e7ec6b-8b34-4c92-a95b-2e2647922e47",
"failure_detail": {
"reason": "Card Failure"
},
"amount": {
"currency": "USD",
"amount": 100,
"includes_tax": false
}
},
"meta": {
"owner": "store",
"subscription_id": "00000000-0000-0000-0000-000000000000",
"invoice_id": "00000000-0000-0000-0000-000000000000",
"job_id": "00000000-0000-0000-0000-000000000000",
"timestamps": {
"updated_at": "2017-01-10T11:41:19.244842Z",
"created_at": "2017-01-10T11:41:19.244842Z",
"payment_taken_at": "2017-01-10T11:41:19.244842Z"
},
"manual_payment": false
}
}
],
"links": {}
}
Authorization: http
name: BearerTokentype: httpscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices/:invoice_uuid/payments' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear