younifyd
Menu

List Subscription Plans

List subscription plans

GET/v2/subscriptions/subscriptions/{subscription_uuid}/plans

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Subscription Plans action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{listSubscriptionPlans.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 {{listSubscriptionPlans.response.data.<field>}}.

dataarray<object>
idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_offering_plan

attributesanyrequired
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.

metaobjectrequired5 fields
json
{
  "data": [
    {
      "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"
          }
        }
      }
    }
  ]
}

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