younifyd
Menu

List Invoice Payment Refunds

List invoice payment refunds

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

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Invoice Payment Refunds action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{listInvoicePaymentRefunds.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.

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 {{listInvoicePaymentRefunds.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_refund`.

One ofsubscription_invoice_payment_refund

attributesobjectrequired5 fields
relationshipsanyrequired

Relationships are established between different subscription entities. For example, a plan and a pricing option are related to an offering, as both are attached to it.

linksobject
json
{
  "data": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "subscription_invoice_payment_refund",
      "attributes": {
        "amount": 100,
        "reason": "Customer requested cancellation",
        "gateway": "elastic_path_payments_stripe",
        "external_refund_id": "33e7ec6b-8b34-4c92-a95b-2e2647922e47",
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "relationships": {
        "pricing-options": {
          "links": {
            "related": "/offerings/:offering-id/pricing-options",
            "self": "/offerings/:offering-id"
          },
          "data": {
            "type": "offering-pricing-option",
            "id": "625fe958-7b4b-40a0-a2c0-dbb8f31eec0d"
          }
        }
      }
    }
  ],
  "links": {}
}

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