younifyd
Menu

Get Invoice Payment

Get invoice payment

GET/v2/subscriptions/invoices/{invoice_uuid}/payments/{payment_uuid}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Invoice Payment action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{getInvoicePayment.response.data}}.

Request

Path parameters

invoice_uuidstring (uuid)required

The unique identifier of the invoice.

payment_uuidstring (uuid)required

The unique identifier of the payment.

Response

Returns 200 with an object. Read it in later steps with {{getInvoicePayment.response.data.<field>}}.

dataobject
idstring (uuid)required

The unique identifier.

typestringrequired

This represents the type of resource object being returned. Always `subscription_invoice_payment`.

One ofsubscription_invoice_payment

attributesobjectrequired6 fields
metaobjectrequired6 fields
json
{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_invoice_payment",
    "attributes": {
      "success": true,
      "gateway": "elastic_path_payments_stripe",
      "amount": {
        "currency": "USD",
        "amount": 100,
        "includes_tax": false
      },
      "pending": true,
      "external_payment_id": "33e7ec6b-8b34-4c92-a95b-2e2647922e47",
      "failure_detail": {
        "reason": "Card Failure"
      }
    },
    "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": null,
      "manual_payment": false
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.