Get subscription invoice payment

GET 
/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

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.

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
    }
  }
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "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"
    }
  ]
}

Loading...