Get Subscription Pricing Option

Get a pricing option in a subscription

GET/v2/subscriptions/subscriptions/{subscription_uuid}/pricing-options/{pricing_option_uuid}

Use it in a workflow

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

Request

Path parameters

subscription_uuidstring (uuid)required

The unique identifier of the subscription.

pricing_option_uuidstring (uuid)required

The unique identifier of the pricing option.

Response

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

dataobject

idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_offering_pricing_option

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.

metaobjectrequired6 fields

json

{
  "data": {
    "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"
        }
      }
    }
  }
}

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

Was this page helpful?