List Subscriptions

List subscriptions

GET/v2/subscriptions/subscriptions

Use it in a workflow

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

Request

Query parameters

filterstring (string)

Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.

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.

includearray<string>

A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).

Response

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

dataarray<object>

idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription

attributesobjectrequired8 fields

relationshipsany

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.

metaobjectrequired14 fields

includedobject

plansarray<object>5 fields

pricing_optionsarray<object>5 fields

linksobject

json

{
  "data": [
    {
      "type": "subscription",
      "attributes": {
        "account_id": "11111111-2222-3333-4444-555555555555",
        "offering": {
          "type": "subscription_offering",
          "attributes": null,
          "meta": {
            "external_plan_refs": [
              null
            ],
            "owner": "store",
            "timestamps": {
              "updated_at": null,
              "created_at": null
            }
          },
          "id": "11111111-2222-3333-4444-555555555555",
          "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"
              }
            }
          }
        },
        "pricing_option_id": "11111111-2222-3333-4444-555555555555",
        "plan_id": "11111111-2222-3333-4444-555555555555",
        "currency": "USD",
        "external_ref": "abc123",
        "address_id": "11111111-2222-3333-4444-555555555555",
        "payment_authority": {
          "type": "elastic_path_payments_stripe"
        }
      },
      "meta": {
        "owner": "store",
        "timestamps": null,
        "status": "active",
        "manual_payments": false,
        "first_invoice_prepaid": false,
        "canceled": true,
        "paused": true,
        "closed": true,
        "suspended": false,
        "pending": false,
        "invoice_after": "2017-01-10T11:41:19.244842Z",
        "state": {
          "type": "subscription_state",
          "attributes": {
            "action": "cancel",
            "cancel_immediately": false
          },
          "meta": {
            "created_at": "2017-01-10T11:41:19.244842Z"
          },
          "id": "11111111-2222-3333-4444-555555555555"
        }
      },
      "id": "11111111-2222-3333-4444-555555555555",
      "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"
          }
        }
      }
    }
  ],
  "included": {
    "plans": [
      {
        "type": "subscription_offering_plan",
        "attributes": null,
        "meta": {
          "owner": "store",
          "timestamps": {
            "updated_at": "2017-01-10T11:41:19.244842Z",
            "created_at": "2017-01-10T11:41:19.244842Z"
          },
          "prices": {},
          "display_price": {
            "without_tax": {
              "amount": 100,
              "currency": "USD",
              "formatted": "$1.00"
            },
            "with_tax": {
              "amount": 110,
              "currency": "USD",
              "formatted": "$1.10"
            },
            "tax": {
              "amount": 10,
              "currency": "USD",
              "formatted": "$0.10"
            }
          },
          "active_plan": true
        },
        "id": "11111111-2222-3333-4444-555555555555",
        "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"
            }
          }
        }
      }
    ],
    "pricing_options": [
      {
        "type": "subscription_offering_pricing_option",
        "attributes": null,
        "meta": {
          "owner": "store",
          "timestamps": {
            "updated_at": "2017-01-10T11:41:19.244842Z",
            "created_at": "2017-01-10T11:41:19.244842Z"
          },
          "prices": {},
          "price": {
            "USD": {
              "type": "object",
              "description": "(schema truncated: exceeded maximum nesting depth)"
            },
            "GBP": {
              "type": "object",
              "description": "(schema truncated: exceeded maximum nesting depth)"
            }
          },
          "display_price": {
            "without_tax": {
              "amount": 100,
              "currency": "USD",
              "formatted": "$1.00"
            },
            "with_tax": {
              "amount": 110,
              "currency": "USD",
              "formatted": "$1.10"
            },
            "tax": {
              "amount": 10,
              "currency": "USD",
              "formatted": "$0.10"
            }
          },
          "active_pricing_option": true
        },
        "id": "11111111-2222-3333-4444-555555555555",
        "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.

Was this page helpful?