younifyd
Menu

List Subscription Invoice Payments

List subscription invoice payments

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

Use it in a workflow

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

Request

Path parameters

subscription_uuidstring (uuid)required

The unique identifier of the subscription.

invoice_uuidstring (uuid)required

The unique identifier of the invoice.

Query parameters

page[offset]integer (int64)

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](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

page[limit]integer (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](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

Response

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

dataarray<object>
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
linksobject
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
      }
    }
  ],
  "links": {}
}

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