List invoice payments
GET/subscriptions/invoices/:invoice_uuid/payments
List invoice payments
Request
Path Parameters
The unique identifier of the invoice.
Query Parameters
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.
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
- Array [
- ]
data SubscriptionInvoicePayment[]
The unique identifier.
Possible values: [subscription_invoice_payment
]
This represents the type of resource object being returned. Always subscription_invoice_payment
.
attributes SubscriptionInvoicePaymentAttributesrequired
Whether the payment was successful.
Whether the payment is pending (only for manual payments).
Possible values: <= 1024 characters
Specifies the payment gateway.
Possible values: <= 1024 characters
An optional external ID that is specific to the gateway used.
failure_detail object
The reason the payment failed.
amount SingleCurrencyPricerequired
A price in a single currency.
Possible values: <= 1024 characters
The three-letter ISO currency code in uppercase, associated with a price.
The value as a whole number of the currency's smallest subdivision.
Whether the amount includes any taxes.
meta SubscriptionInvoicePaymentMetarequired
The owner of a resource, either store
or organization
.
The unique identifier.
The unique identifier.
The unique identifier.
timestamps Timestampsrequired
The date and time a resource was updated.
The date and time a resource was created.
The date and time a payment was taken.
Whether manual payments are enabled or the payment will be handled by the configured gateway.
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": {}
}