Get Subscription State

Get subscription state

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

Use it in a workflow

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

Request

Path parameters

subscription_uuidstring (uuid)required

The unique identifier of the subscription.

state_uuidstring (uuid)required

The unique identifier of the subscription state.

Response

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

dataobject

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.

Was this page helpful?