younifyd
Menu

List Subscription States

List subscription states

GET/v2/subscriptions/subscriptions/{subscription_uuid}/states

Use it in a workflow

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

Request

Path parameters

subscription_uuidstring (uuid)required

The unique identifier of the subscription.

Response

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

dataarray<object>
idstring (uuid)

The unique identifier.

typestringrequired

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

One ofsubscription_state

attributesobjectrequired2 fields
metaobjectrequired1 fields
json
{
  "data": [
    {
      "type": "subscription_state",
      "attributes": {
        "action": "cancel",
        "cancel_immediately": false
      },
      "meta": {
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "id": "11111111-2222-3333-4444-555555555555"
    }
  ]
}

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

List Subscription States — Elastic Path — Documentation