Get subscription invoice payment

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

Gets a specific payment 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.

payment_uuid UUIDrequired

The unique identifier of the payment.

Responses

200

Success. Specific payment for the invoice is returned.

application/json

Schema

Schema

data SubscriptionInvoicePayment
idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
typeSubscriptionInvoicePaymentType (string)required
This represents the type of resource object being returned. Always subscription_invoice_payment.
Possible values: [subscription_invoice_payment]
Example: subscription_invoice_payment
attributes SubscriptionInvoicePaymentAttributesrequired
successbooleanrequired
Whether the payment was successful.
Example: true
pendingboolean
Whether the payment is pending (only for manual payments).
Example: true
gatewaystringrequired
Specifies the payment gateway.
Possible values: <= 1024 characters
Example: elastic_path_payments_stripe
external_payment_idstring
An optional external ID that is specific to the gateway used.
Possible values: <= 1024 characters
Example: 33e7ec6b-8b34-4c92-a95b-2e2647922e47
failure_detail object
The reason the payment failed.
reasonstring
Example: Card Failure
amount SingleCurrencyPricerequired
A price in a single currency.
currencystringrequired
The three-letter ISO currency code in uppercase, associated with a price.
Possible values: <= 1024 characters
Example: USD
amountint64required
The value as a whole number of the currency's smallest subdivision.
Example: 100
includes_taxboolean
Whether the amount includes any taxes.
Example: true
meta SubscriptionInvoicePaymentMetarequired
ownerstringrequired
The owner of a resource, either store or organization.
Example: store
subscription_idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
invoice_idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
job_idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
timestamps InvoicePaymentTimestamps
updated_atstringrequired
The date and time a resource was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstringrequired
The date and time a resource was created.
Example: 2017-01-10T11:41:19.244842Z
payment_taken_atstring
The date and time a payment was taken.
Example: 2017-01-10T11:41:19.244842Z
manual_paymentbooleanrequired
Whether manual payments are enabled or the payment will be handled by the configured gateway.
Example: false

Example (auto)

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "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": "11111111-2222-3333-4444-555555555555",
      "invoice_id": "11111111-2222-3333-4444-555555555555",
      "job_id": "11111111-2222-3333-4444-555555555555",
      "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
    }
  }
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices/:invoice_uuid/payments/:payment_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

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

Auth

Bearer Token

Parameters

subscription_uuid — pathrequired

invoice_uuid — pathrequired

payment_uuid — pathrequired

ResponseClear

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