Update Subscription

Update a subscription

PUT/v2/subscriptions/subscriptions/{subscription_uuid}

Use it in a workflow

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

Request

Path parameters

subscription_uuidstring (uuid)required

The unique identifier of the subscription.

Request body

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

dataobjectrequired

idstring (uuid)required

The unique identifier.

typestringrequired

One ofsubscription

attributesobjectrequired5 fields

json

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription",
    "attributes": {
      "pricing_option_id": "00000000-0000-0000-0000-000000000001",
      "plan_id": "00000000-0000-0000-0000-000000000001",
      "address_id": "00000000-0000-0000-0000-000000000001",
      "payment_authority": {
        "type": "elastic_path_payments_stripe"
      },
      "go_live_after": "2017-01-10T11:41:19.244842Z"
    }
  }
}

Response

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

dataobject

idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription

attributesobjectrequired8 fields

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.

metaobjectrequired14 fields

json

{
  "data": {
    "type": "subscription",
    "attributes": {
      "account_id": "11111111-2222-3333-4444-555555555555",
      "offering": {
        "type": "subscription_offering",
        "attributes": null,
        "meta": {
          "external_plan_refs": [
            "97dddc65-eabd-45d8-b45b-2ece5cfc8c50"
          ],
          "owner": "store",
          "timestamps": {
            "updated_at": "2017-01-10T11:41:19.244842Z",
            "created_at": "2017-01-10T11:41:19.244842Z"
          }
        },
        "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"
            }
          }
        }
      },
      "pricing_option_id": "11111111-2222-3333-4444-555555555555",
      "plan_id": "11111111-2222-3333-4444-555555555555",
      "currency": "USD",
      "external_ref": "abc123",
      "address_id": "11111111-2222-3333-4444-555555555555",
      "payment_authority": {
        "type": "elastic_path_payments_stripe"
      }
    },
    "meta": {
      "owner": "store",
      "timestamps": null,
      "status": "active",
      "manual_payments": false,
      "first_invoice_prepaid": false,
      "canceled": true,
      "paused": true,
      "closed": true,
      "suspended": false,
      "pending": false,
      "invoice_after": "2017-01-10T11:41:19.244842Z",
      "state": {
        "type": "subscription_state",
        "attributes": {
          "action": "cancel",
          "cancel_immediately": false
        },
        "meta": {
          "created_at": "2017-01-10T11:41:19.244842Z"
        },
        "id": "11111111-2222-3333-4444-555555555555"
      }
    },
    "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?