younifyd
Menu

List Offering Pricing Options

List an offering's pricing options

GET/v2/subscriptions/offerings/{offering_uuid}/pricing-options

Use it in a workflow

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

Request

Path parameters

offering_uuidstring (uuid)required

The unique identifier of the offering.

Query parameters

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.

Response

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

dataarray<object>
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
linksobject
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"
          }
        }
      }
    }
  ],
  "links": {}
}

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