List invoice payments

GET 
https://euwest.api.elasticpath.com/v2/subscriptions/invoices/:invoice_uuid/payments

List invoice payments

Request

Path Parameters

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

Schema

data SubscriptionInvoicePayment[]
Array [
id UUID (string)required
The unique identifier.
type SubscriptionInvoicePaymentType (string)required
Possible values: [subscription_invoice_payment]
This represents the type of resource object being returned. Always subscription_invoice_payment.
attributes SubscriptionInvoicePaymentAttributesrequired
success booleanrequired
Whether the payment was successful.
pending boolean
Whether the payment is pending (only for manual payments).
gateway stringrequired
Possible values: <= 1024 characters
Specifies the payment gateway.
external_payment_id string
Possible values: <= 1024 characters
An optional external ID that is specific to the gateway used.
failure_detail object
The reason the payment failed.
reason string
amount SingleCurrencyPricerequired
A price in a single currency.
currency stringrequired
Possible values: <= 1024 characters
The three-letter ISO currency code in uppercase, associated with a price.
amount int64required
The value as a whole number of the currency's smallest subdivision.
includes_tax boolean
Whether the amount includes any taxes.
meta SubscriptionInvoicePaymentMetarequired
owner stringrequired
The owner of a resource, either store or organization.
subscription_id UUID (string)required
The unique identifier.
invoice_id UUID (string)required
The unique identifier.
job_id UUID (string)required
The unique identifier.
timestamps Timestampsrequired
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
payment_taken_at string
The date and time a payment was taken.
manual_payment booleanrequired
Whether manual payments are enabled or the payment will be handled by the configured gateway.
]
links object
anyOf
title

Example (from schema)

{
  "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/invoices/:invoice_uuid/payments' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

invoice_uuid — pathrequired

page[offset] — query

page[limit] — query

ResponseClear

Click the Send API Request button above and see the response here!