younifyd
Menu

Update Offering Pricing Option

Update a pricing option in an offering

PUT/v2/subscriptions/offerings/{offering_uuid}/pricing-options/{pricing_option_uuid}

Use it in a workflow

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

Request

Path parameters

offering_uuidstring (uuid)required

The unique identifier of the offering.

pricing_option_uuidstring (uuid)required

The unique identifier of the pricing option.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
idstring (uuid)required

The unique identifier.

typestringrequired

One ofsubscription_offering_pricing_option

attributesobjectrequired15 fields
json
{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_offering_pricing_option",
    "attributes": {
      "external_ref": "abc123",
      "name": "Monthly",
      "description": "A monthly subscription.",
      "billing_interval_type": "month",
      "billing_frequency": 1,
      "trial_period": 7,
      "plan_length": 12,
      "lead_time": {
        "type": "week",
        "time": 14
      },
      "notification_schedule": [
        {
          "name": "Daily billing run.",
          "unit": "day",
          "amount": 100
        }
      ],
      "end_behavior": "close",
      "can_pause": false,
      "can_resume": false
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateOfferingPricingOption.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.