younifyd
Menu

Create Proration Policy

Create a Proration Policy

POST/v2/subscriptions/proration-policies

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Create Proration Policy action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{createProrationPolicy.response.data}}.

Request

Request body

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

dataobjectrequired
typestringrequired

One ofsubscription_proration_policy

attributesobjectrequired3 fields
json
{
  "data": {
    "type": "subscription_proration_policy",
    "attributes": {
      "name": "Main Policy",
      "rounding": "up",
      "external_ref": "abc123"
    }
  }
}

Response

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

dataobject
idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_proration_policy

attributesanyrequired
metaobjectrequired2 fields
json
{
  "data": {
    "type": "subscription_proration_policy",
    "attributes": null,
    "meta": {
      "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"
  }
}

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

Create Proration Policy — Elastic Path — Documentation