Skip to main content
POST
/
companies
/
{company_id}
/
subscriptions
/
{id}
/
change
Change Subscription
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config_items": [
    {
      "hide_at_checkout": true,
      "minimum_units": 1,
      "num_licenses": 1,
      "product_metric_pricing_id": "<string>",
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": 123,
      "upsell_product_metric_pricing_id": "<string>"
    }
  ],
  "product_pricing_ids": [
    "<string>"
  ],
  "auto_charges": true,
  "auto_renews": true,
  "custom_change_date": "2023-11-07T05:31:56Z",
  "discounts": [
    {
      "name": "<string>",
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "cap": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "expiration_date": "2023-11-07T05:31:56Z",
      "percent": 0,
      "product_pricing_id": "<string>"
    }
  ],
  "metadata": {},
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "onetime_items": [
    {
      "aggregate": 123,
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": 123
    }
  ],
  "payment_method_id": "<string>",
  "reset_billing_anchor": true,
  "trial": true
}
'
import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change"

payload = {
    "config_items": [
        {
            "hide_at_checkout": True,
            "minimum_units": 1,
            "num_licenses": 1,
            "product_metric_pricing_id": "<string>",
            "product_pricing_id": "<string>",
            "quantity_config": {
                "allow_custom_quantity": True,
                "max_quantity": 123,
                "min_quantity": 123
            },
            "sort_order": 123,
            "upsell_product_metric_pricing_id": "<string>"
        }
    ],
    "product_pricing_ids": ["<string>"],
    "auto_charges": True,
    "auto_renews": True,
    "custom_change_date": "2023-11-07T05:31:56Z",
    "discounts": [
        {
            "name": "<string>",
            "amount": {
                "currency": "<string>",
                "value_in_cents": 123
            },
            "cap": {
                "currency": "<string>",
                "value_in_cents": 123
            },
            "expiration_date": "2023-11-07T05:31:56Z",
            "percent": 0,
            "product_pricing_id": "<string>"
        }
    ],
    "metadata": {},
    "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
    },
    "onetime_items": [
        {
            "aggregate": 123,
            "product_pricing_id": "<string>",
            "quantity_config": {
                "allow_custom_quantity": True,
                "max_quantity": 123,
                "min_quantity": 123
            },
            "sort_order": 123
        }
    ],
    "payment_method_id": "<string>",
    "reset_billing_anchor": True,
    "trial": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config_items: [
      {
        hide_at_checkout: true,
        minimum_units: 1,
        num_licenses: 1,
        product_metric_pricing_id: '<string>',
        product_pricing_id: '<string>',
        quantity_config: {allow_custom_quantity: true, max_quantity: 123, min_quantity: 123},
        sort_order: 123,
        upsell_product_metric_pricing_id: '<string>'
      }
    ],
    product_pricing_ids: ['<string>'],
    auto_charges: true,
    auto_renews: true,
    custom_change_date: '2023-11-07T05:31:56Z',
    discounts: [
      {
        name: '<string>',
        amount: {currency: '<string>', value_in_cents: 123},
        cap: {currency: '<string>', value_in_cents: 123},
        expiration_date: '2023-11-07T05:31:56Z',
        percent: 0,
        product_pricing_id: '<string>'
      }
    ],
    metadata: {},
    minimum_spend: {currency: '<string>', value_in_cents: 123},
    onetime_items: [
      {
        aggregate: 123,
        product_pricing_id: '<string>',
        quantity_config: {allow_custom_quantity: true, max_quantity: 123, min_quantity: 123},
        sort_order: 123
      }
    ],
    payment_method_id: '<string>',
    reset_billing_anchor: true,
    trial: true
  })
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'config_items' => [
        [
                'hide_at_checkout' => true,
                'minimum_units' => 1,
                'num_licenses' => 1,
                'product_metric_pricing_id' => '<string>',
                'product_pricing_id' => '<string>',
                'quantity_config' => [
                                'allow_custom_quantity' => true,
                                'max_quantity' => 123,
                                'min_quantity' => 123
                ],
                'sort_order' => 123,
                'upsell_product_metric_pricing_id' => '<string>'
        ]
    ],
    'product_pricing_ids' => [
        '<string>'
    ],
    'auto_charges' => true,
    'auto_renews' => true,
    'custom_change_date' => '2023-11-07T05:31:56Z',
    'discounts' => [
        [
                'name' => '<string>',
                'amount' => [
                                'currency' => '<string>',
                                'value_in_cents' => 123
                ],
                'cap' => [
                                'currency' => '<string>',
                                'value_in_cents' => 123
                ],
                'expiration_date' => '2023-11-07T05:31:56Z',
                'percent' => 0,
                'product_pricing_id' => '<string>'
        ]
    ],
    'metadata' => [
        
    ],
    'minimum_spend' => [
        'currency' => '<string>',
        'value_in_cents' => 123
    ],
    'onetime_items' => [
        [
                'aggregate' => 123,
                'product_pricing_id' => '<string>',
                'quantity_config' => [
                                'allow_custom_quantity' => true,
                                'max_quantity' => 123,
                                'min_quantity' => 123
                ],
                'sort_order' => 123
        ]
    ],
    'payment_method_id' => '<string>',
    'reset_billing_anchor' => true,
    'trial' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change"

	payload := strings.NewReader("{\n  \"config_items\": [\n    {\n      \"hide_at_checkout\": true,\n      \"minimum_units\": 1,\n      \"num_licenses\": 1,\n      \"product_metric_pricing_id\": \"<string>\",\n      \"product_pricing_id\": \"<string>\",\n      \"quantity_config\": {\n        \"allow_custom_quantity\": true,\n        \"max_quantity\": 123,\n        \"min_quantity\": 123\n      },\n      \"sort_order\": 123,\n      \"upsell_product_metric_pricing_id\": \"<string>\"\n    }\n  ],\n  \"product_pricing_ids\": [\n    \"<string>\"\n  ],\n  \"auto_charges\": true,\n  \"auto_renews\": true,\n  \"custom_change_date\": \"2023-11-07T05:31:56Z\",\n  \"discounts\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"value_in_cents\": 123\n      },\n      \"cap\": {\n        \"currency\": \"<string>\",\n        \"value_in_cents\": 123\n      },\n      \"expiration_date\": \"2023-11-07T05:31:56Z\",\n      \"percent\": 0,\n      \"product_pricing_id\": \"<string>\"\n    }\n  ],\n  \"metadata\": {},\n  \"minimum_spend\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  },\n  \"onetime_items\": [\n    {\n      \"aggregate\": 123,\n      \"product_pricing_id\": \"<string>\",\n      \"quantity_config\": {\n        \"allow_custom_quantity\": true,\n        \"max_quantity\": 123,\n        \"min_quantity\": 123\n      },\n      \"sort_order\": 123\n    }\n  ],\n  \"payment_method_id\": \"<string>\",\n  \"reset_billing_anchor\": true,\n  \"trial\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_items\": [\n    {\n      \"hide_at_checkout\": true,\n      \"minimum_units\": 1,\n      \"num_licenses\": 1,\n      \"product_metric_pricing_id\": \"<string>\",\n      \"product_pricing_id\": \"<string>\",\n      \"quantity_config\": {\n        \"allow_custom_quantity\": true,\n        \"max_quantity\": 123,\n        \"min_quantity\": 123\n      },\n      \"sort_order\": 123,\n      \"upsell_product_metric_pricing_id\": \"<string>\"\n    }\n  ],\n  \"product_pricing_ids\": [\n    \"<string>\"\n  ],\n  \"auto_charges\": true,\n  \"auto_renews\": true,\n  \"custom_change_date\": \"2023-11-07T05:31:56Z\",\n  \"discounts\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"value_in_cents\": 123\n      },\n      \"cap\": {\n        \"currency\": \"<string>\",\n        \"value_in_cents\": 123\n      },\n      \"expiration_date\": \"2023-11-07T05:31:56Z\",\n      \"percent\": 0,\n      \"product_pricing_id\": \"<string>\"\n    }\n  ],\n  \"metadata\": {},\n  \"minimum_spend\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  },\n  \"onetime_items\": [\n    {\n      \"aggregate\": 123,\n      \"product_pricing_id\": \"<string>\",\n      \"quantity_config\": {\n        \"allow_custom_quantity\": true,\n        \"max_quantity\": 123,\n        \"min_quantity\": 123\n      },\n      \"sort_order\": 123\n    }\n  ],\n  \"payment_method_id\": \"<string>\",\n  \"reset_billing_anchor\": true,\n  \"trial\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}/change")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config_items\": [\n    {\n      \"hide_at_checkout\": true,\n      \"minimum_units\": 1,\n      \"num_licenses\": 1,\n      \"product_metric_pricing_id\": \"<string>\",\n      \"product_pricing_id\": \"<string>\",\n      \"quantity_config\": {\n        \"allow_custom_quantity\": true,\n        \"max_quantity\": 123,\n        \"min_quantity\": 123\n      },\n      \"sort_order\": 123,\n      \"upsell_product_metric_pricing_id\": \"<string>\"\n    }\n  ],\n  \"product_pricing_ids\": [\n    \"<string>\"\n  ],\n  \"auto_charges\": true,\n  \"auto_renews\": true,\n  \"custom_change_date\": \"2023-11-07T05:31:56Z\",\n  \"discounts\": [\n    {\n      \"name\": \"<string>\",\n      \"amount\": {\n        \"currency\": \"<string>\",\n        \"value_in_cents\": 123\n      },\n      \"cap\": {\n        \"currency\": \"<string>\",\n        \"value_in_cents\": 123\n      },\n      \"expiration_date\": \"2023-11-07T05:31:56Z\",\n      \"percent\": 0,\n      \"product_pricing_id\": \"<string>\"\n    }\n  ],\n  \"metadata\": {},\n  \"minimum_spend\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  },\n  \"onetime_items\": [\n    {\n      \"aggregate\": 123,\n      \"product_pricing_id\": \"<string>\",\n      \"quantity_config\": {\n        \"allow_custom_quantity\": true,\n        \"max_quantity\": 123,\n        \"min_quantity\": 123\n      },\n      \"sort_order\": 123\n    }\n  ],\n  \"payment_method_id\": \"<string>\",\n  \"reset_billing_anchor\": true,\n  \"trial\": true\n}"

response = http.request(request)
puts response.read_body
{
  "arr": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "auto_charges": true,
  "auto_renews": true,
  "billing_anchor_date": "2023-11-07T05:31:56Z",
  "cancel_config": {
    "campaign_id": "<string>",
    "campaign_step_id": "<string>",
    "charge_remaining_balance": true,
    "custom_end_date": "2023-11-07T05:31:56Z",
    "custom_refund_amount": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "reason": "<string>",
    "refund_type": "<string>",
    "send_customer_receipt": true,
    "timing": "<string>"
  },
  "cancel_date": "2023-11-07T05:31:56Z",
  "change_config": {
    "actual_change_time": "2023-11-07T05:31:56Z",
    "all_product_pricings": [
      {
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "original_value": "<unknown>",
            "overriden": true,
            "value": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "currency": "<string>",
        "deleted_at": {},
        "description": "<string>",
        "external_name": "<string>",
        "id": "<string>",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "metadata": {},
        "minimum_spend": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "name": "<string>",
        "num_subs": 1,
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "original_value": "<unknown>",
            "overriden": true,
            "value": "<unknown>"
          }
        ],
        "product_id": "<string>",
        "product_metric_pricings": [
          {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "deleted_at": {},
            "id": "<string>",
            "item_id": "<string>",
            "item_pricing_id": "<string>",
            "metric_id": "<string>",
            "product_id": "<string>",
            "product_pricing_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "state": "<string>",
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "upsell_product_pricing": "<unknown>",
        "upsell_product_pricing_id": "<string>"
      }
    ],
    "auto_charges": true,
    "auto_renews": true,
    "bundle_pricing": {
      "bundle_product_pricings": [
        {
          "bundle_pricing_id": "<string>",
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "deleted_at": {},
          "id": "<string>",
          "product_id": "<string>",
          "product_pricing_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "company_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "default_term": {
        "count": 123
      },
      "deleted_at": {},
      "description": "<string>",
      "id": "<string>",
      "image_url": "<string>",
      "import_created_at_ref": "2023-11-07T05:31:56Z",
      "import_ref": "<string>",
      "imported_from": "<string>",
      "is_auto_generated": true,
      "key": "<string>",
      "metadata": {},
      "name": "<string>",
      "num_subs": 1,
      "state": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "bundle_pricing_id": "<string>",
    "config_items": [
      {
        "hide_at_checkout": true,
        "minimum_units": 1,
        "num_licenses": 1,
        "product_metric_pricing_id": "<string>",
        "product_pricing_id": "<string>",
        "quantity_config": {
          "allow_custom_quantity": true,
          "max_quantity": 123,
          "min_quantity": 123
        },
        "sort_order": 123,
        "upsell_product_metric_pricing_id": "<string>"
      }
    ],
    "custom_change_date": "2023-11-07T05:31:56Z",
    "discounts": [
      {
        "name": "<string>",
        "amount": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "cap": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "coupon_id": "<string>",
        "customer_id": "<string>",
        "expiration_date": "2023-11-07T05:31:56Z",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "item_pricing_id": "<string>",
        "onetime_billable_id": "<string>",
        "percent": 0.5,
        "product_id": "<string>",
        "product_pricing_id": "<string>",
        "proposal_id": "<string>",
        "subscription_id": "<string>"
      }
    ],
    "metadata": {},
    "minimum_spend": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "onetime_items": [
      {
        "aggregate": 123,
        "custom_price": {
          "amount": {
            "currency": "<string>",
            "value_in_cents": 123
          },
          "product_id": "<string>",
          "description": "<string>"
        },
        "product_pricing_id": "<string>",
        "quantity_config": {
          "allow_custom_quantity": true,
          "max_quantity": 123,
          "min_quantity": 123
        },
        "sort_order": 123
      }
    ],
    "payment_method_id": "<string>",
    "product_pricing_ids": [
      "<string>"
    ],
    "relative_term": {
      "count": 123
    },
    "reset_billing_anchor": true,
    "term": {
      "count": 123
    },
    "trial": true,
    "trial_term": {
      "count": 123
    }
  },
  "change_date": "2023-11-07T05:31:56Z",
  "company_id": "<string>",
  "computed_entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "inherited_from_id": "<string>",
      "inherited_from_type": "<string>",
      "key": "<string>",
      "name": "<string>",
      "original_value": "<unknown>",
      "overridden": true,
      "type": "<string>",
      "value": "<unknown>"
    }
  ],
  "config_items": [
    {
      "hide_at_checkout": true,
      "minimum_units": 1,
      "num_licenses": 1,
      "product_metric_pricing_id": "<string>",
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": 123,
      "upsell_product_metric_pricing_id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "arr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "billing_emails": [
      "<string>"
    ],
    "company_id": "<string>",
    "computed_entitlements": [
      {
        "entitlement_id": "<string>",
        "id": "<string>",
        "inherited_from_id": "<string>",
        "inherited_from_type": "<string>",
        "key": "<string>",
        "name": "<string>",
        "original_value": "<unknown>",
        "overridden": true,
        "type": "<string>",
        "value": "<unknown>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "customer_integration_metadata": {},
    "display_name": "<string>",
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "integration_references": [
      {
        "integration_icon": "<string>",
        "integration_id": "<string>",
        "integration_key": "<string>",
        "integration_name": "<string>",
        "reference_type": "<string>",
        "remote_id": "<string>",
        "remote_type": "<string>"
      }
    ],
    "locale": "<string>",
    "managed_externally": true,
    "metadata": {},
    "mrr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": "<string>",
    "parent_customer_id": "<string>",
    "phone": "<string>",
    "status": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "customer_id": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "invoice_additional_display_fields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "invoice_due_date_from_creation": 1,
  "metadata": {},
  "minimum_spend": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "mrr": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "next_invoice_date": "2023-11-07T05:31:56Z",
  "override_entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "inherited_from_id": "<string>",
      "inherited_from_type": "<string>",
      "key": "<string>",
      "name": "<string>",
      "original_value": "<unknown>",
      "overridden": true,
      "type": "<string>",
      "value": "<unknown>"
    }
  ],
  "pause_config": {
    "behavior": "<string>",
    "resume_date": "2023-11-07T05:31:56Z"
  },
  "pause_date": "2023-11-07T05:31:56Z",
  "payment_method_id": "<string>",
  "product_pricing_ids": [
    "<string>"
  ],
  "product_pricings": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "external_name": "<string>",
      "id": "<string>",
      "name": "<string>",
      "product": {
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "external_name": "<string>",
        "gl_code": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "product_pricings": [
          {
            "company_id": "<string>",
            "computed_entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "name": "<string>",
                "original_value": "<unknown>",
                "overridden": true,
                "type": "<string>",
                "value": "<unknown>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "currency": "<string>",
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "import_created_at_ref": "2023-11-07T05:31:56Z",
            "import_ref": "<string>",
            "imported_from": "<string>",
            "metadata": {},
            "minimum_spend": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "name": "<string>",
            "num_subs": 1,
            "override_entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "name": "<string>",
                "original_value": "<unknown>",
                "overridden": true,
                "type": "<string>",
                "value": "<unknown>"
              }
            ],
            "product": "<unknown>",
            "product_id": "<string>",
            "product_metric_pricings": [
              {
                "company_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "id": "<string>",
                "item": {
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "description": "<string>",
                  "display_type": "<string>",
                  "editable": true,
                  "external_name": "<string>",
                  "id": "<string>",
                  "name": "<string>",
                  "standard": true,
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z"
                },
                "item_id": "<string>",
                "item_pricing": {
                  "base_price": {
                    "currency": "<string>",
                    "value_in_cents": 123
                  },
                  "base_units": 123,
                  "charge_type": "<string>",
                  "company": {
                    "address": {
                      "address_line_1": "<string>",
                      "address_line_2": "<string>",
                      "city": "<string>",
                      "country": "<string>",
                      "place_id": "<string>",
                      "state": "<string>",
                      "zip": "<string>"
                    },
                    "computed_entitlements": {},
                    "created_at": "2023-11-07T05:31:56Z",
                    "customer_id": "<string>",
                    "demo": true,
                    "email": "<string>",
                    "entitlements": [
                      {
                        "entitlement_id": "<string>",
                        "id": "<string>",
                        "inherited_from_id": "<string>",
                        "inherited_from_type": "<string>",
                        "key": "<string>",
                        "name": "<string>",
                        "original_value": "<unknown>",
                        "overridden": true,
                        "type": "<string>",
                        "value": "<unknown>"
                      }
                    ],
                    "id": "<string>",
                    "is_dev": true,
                    "legal_name": "<string>",
                    "name": "<string>",
                    "override_entitlements": [
                      {
                        "entitlement_id": "<string>",
                        "id": "<string>",
                        "inherited_from_id": "<string>",
                        "inherited_from_type": "<string>",
                        "key": "<string>",
                        "name": "<string>",
                        "original_value": "<unknown>",
                        "overridden": true,
                        "type": "<string>",
                        "value": "<unknown>"
                      }
                    ],
                    "phone": "<string>",
                    "preferred_currency": "<string>",
                    "preferred_timezone": "<string>",
                    "slug": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z"
                  },
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "credit_price": {
                    "amount": {
                      "currency": "<string>",
                      "value_in_cents": 123
                    },
                    "item_id": "<string>",
                    "scoped_product_ids": [
                      "<string>"
                    ],
                    "units": 123
                  },
                  "custom_price": {
                    "max_price_per_unit": 123,
                    "min_price_per_unit": 123,
                    "preset_price_per_unit": 123,
                    "price_per_unit": 123
                  },
                  "description": "<string>",
                  "display_type": "<string>",
                  "editable": true,
                  "external_name": "<string>",
                  "fixed_price": {
                    "price_per_unit": 123
                  },
                  "frequency": "<string>",
                  "gradient_price": [
                    {
                      "end": 1,
                      "flat_price": 123,
                      "is_custom_tier": true,
                      "price_per_unit": 123,
                      "start": 1
                    }
                  ],
                  "id": "<string>",
                  "item": {
                    "company_id": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "description": "<string>",
                    "display_type": "<string>",
                    "editable": true,
                    "external_name": "<string>",
                    "id": "<string>",
                    "name": "<string>",
                    "standard": true,
                    "type": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z"
                  },
                  "item_id": "<string>",
                  "metadata": {},
                  "minimum_spend": {
                    "currency": "<string>",
                    "value_in_cents": 123
                  },
                  "minimum_spend_schedule": {
                    "allow_pulling_forward": true,
                    "amount_per_period": [
                      "<string>"
                    ],
                    "minimum_spend_schedule_type": "<string>"
                  },
                  "name": "<string>",
                  "num_subs": 1,
                  "proration_type": "<string>",
                  "recognition_schedule": {
                    "amount_per_period": [
                      "<string>"
                    ]
                  },
                  "scheduled_price": {
                    "price_per_unit_per_period": [
                      "<string>"
                    ]
                  },
                  "state": "<string>",
                  "step_price": {
                    "price_per_step": 123,
                    "step_size": 1
                  },
                  "term_count": 123,
                  "true_up_frequency": "<string>",
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "volume_price": [
                    {
                      "flat_price": 123,
                      "is_custom_tier": true,
                      "price_per_unit": 123,
                      "total_units_end": 1,
                      "total_units_start": 1
                    }
                  ]
                },
                "item_pricing_id": "<string>",
                "metric": {
                  "company_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "description": "<string>",
                  "external_name": "<string>",
                  "id": "<string>",
                  "item_id": "<string>",
                  "metering_rule": {
                    "aggregator": "<string>",
                    "group_keys": [
                      "<string>"
                    ],
                    "property": "<string>",
                    "rule": "<string>"
                  },
                  "name": "<string>",
                  "standard": true,
                  "type": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z"
                },
                "metric_id": "<string>",
                "product": "<unknown>",
                "product_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "upsell_product_pricing_id": "<string>"
          }
        ],
        "state": "<string>",
        "tags": [
          "<string>"
        ],
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "product_id": "<string>",
      "product_metric_pricings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "item": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "display_type": "<string>",
            "editable": true,
            "external_name": "<string>",
            "id": "<string>",
            "name": "<string>",
            "standard": true,
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "item_id": "<string>",
          "item_pricing": {
            "base_price": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "base_units": 123,
            "charge_type": "<string>",
            "company": {
              "address": {
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "city": "<string>",
                "country": "<string>",
                "place_id": "<string>",
                "state": "<string>",
                "zip": "<string>"
              },
              "computed_entitlements": {},
              "created_at": "2023-11-07T05:31:56Z",
              "customer_id": "<string>",
              "demo": true,
              "email": "<string>",
              "entitlements": [
                {
                  "entitlement_id": "<string>",
                  "id": "<string>",
                  "inherited_from_id": "<string>",
                  "inherited_from_type": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<unknown>",
                  "overridden": true,
                  "type": "<string>",
                  "value": "<unknown>"
                }
              ],
              "id": "<string>",
              "is_dev": true,
              "legal_name": "<string>",
              "name": "<string>",
              "override_entitlements": [
                {
                  "entitlement_id": "<string>",
                  "id": "<string>",
                  "inherited_from_id": "<string>",
                  "inherited_from_type": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<unknown>",
                  "overridden": true,
                  "type": "<string>",
                  "value": "<unknown>"
                }
              ],
              "phone": "<string>",
              "preferred_currency": "<string>",
              "preferred_timezone": "<string>",
              "slug": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "credit_price": {
              "amount": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "item_id": "<string>",
              "scoped_product_ids": [
                "<string>"
              ],
              "units": 123
            },
            "custom_price": {
              "max_price_per_unit": 123,
              "min_price_per_unit": 123,
              "preset_price_per_unit": 123,
              "price_per_unit": 123
            },
            "description": "<string>",
            "display_type": "<string>",
            "editable": true,
            "external_name": "<string>",
            "fixed_price": {
              "price_per_unit": 123
            },
            "frequency": "<string>",
            "gradient_price": [
              {
                "end": 1,
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "start": 1
              }
            ],
            "id": "<string>",
            "item": {
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "display_type": "<string>",
              "editable": true,
              "external_name": "<string>",
              "id": "<string>",
              "name": "<string>",
              "standard": true,
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "item_id": "<string>",
            "metadata": {},
            "minimum_spend": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "minimum_spend_schedule": {
              "allow_pulling_forward": true,
              "amount_per_period": [
                "<string>"
              ],
              "minimum_spend_schedule_type": "<string>"
            },
            "name": "<string>",
            "num_subs": 1,
            "proration_type": "<string>",
            "recognition_schedule": {
              "amount_per_period": [
                "<string>"
              ]
            },
            "scheduled_price": {
              "price_per_unit_per_period": [
                "<string>"
              ]
            },
            "state": "<string>",
            "step_price": {
              "price_per_step": 123,
              "step_size": 1
            },
            "term_count": 123,
            "true_up_frequency": "<string>",
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "volume_price": [
              {
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "total_units_end": 1,
                "total_units_start": 1
              }
            ]
          },
          "item_pricing_id": "<string>",
          "metric": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "item_id": "<string>",
            "metering_rule": {
              "aggregator": "<string>",
              "group_keys": [
                "<string>"
              ],
              "property": "<string>",
              "rule": "<string>"
            },
            "name": "<string>",
            "standard": true,
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "metric_id": "<string>",
          "minimum_units": 123,
          "num_licenses": 123,
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "tags": [
        "<string>"
      ],
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "renewal_date": "2023-11-07T05:31:56Z",
  "sales_user": {
    "company": {
      "address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "place_id": "<string>",
        "state": "<string>",
        "zip": "<string>"
      },
      "computed_entitlements": {},
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "demo": true,
      "email": "<string>",
      "entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "id": "<string>",
      "is_dev": true,
      "legal_name": "<string>",
      "name": "<string>",
      "override_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "phone": "<string>",
      "preferred_currency": "<string>",
      "preferred_timezone": "<string>",
      "slug": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "company_id": "<string>",
    "company_user": {
      "access": {
        "api_tokens": "<string>",
        "approvals": "<string>",
        "campaign": "<string>",
        "commission_plans": "<string>",
        "commission_reports": "<string>",
        "companies": "<string>",
        "credit_notes": "<string>",
        "credits": "<string>",
        "customer_portal": "<string>",
        "customers": "<string>",
        "developers": "<string>",
        "disputes": "<string>",
        "email_templates": "<string>",
        "entitlement": "<string>",
        "events": "<string>",
        "expired_card": "<string>",
        "files": "<string>",
        "import": "<string>",
        "integration_bank_accounts": "<string>",
        "integration_transactions": "<string>",
        "integrations": "<string>",
        "invoices": "<string>",
        "journal_accounts": "<string>",
        "journal_entries": "<string>",
        "logs": "<string>",
        "objects": "<string>",
        "one_time": "<string>",
        "payments": "<string>",
        "pricing": "<string>",
        "promotions": "<string>",
        "proposal": "<string>",
        "reports": "<string>",
        "sales_users": "<string>",
        "settings": "<string>",
        "subscriptions": "<string>",
        "team": "<string>",
        "webhooks": "<string>"
      },
      "company": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "computed_entitlements": {},
        "created_at": "2023-11-07T05:31:56Z",
        "customer_id": "<string>",
        "demo": true,
        "email": "<string>",
        "entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "id": "<string>",
        "is_dev": true,
        "legal_name": "<string>",
        "name": "<string>",
        "override_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "phone": "<string>",
        "preferred_currency": "<string>",
        "preferred_timezone": "<string>",
        "slug": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "image_url": "<string>",
      "manager_id": "<string>",
      "pending": true,
      "role": "<string>",
      "title": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "user": {
        "companies": [
          {
            "access": {
              "api_tokens": "<string>",
              "approvals": "<string>",
              "campaign": "<string>",
              "commission_plans": "<string>",
              "commission_reports": "<string>",
              "companies": "<string>",
              "credit_notes": "<string>",
              "credits": "<string>",
              "customer_portal": "<string>",
              "customers": "<string>",
              "developers": "<string>",
              "disputes": "<string>",
              "email_templates": "<string>",
              "entitlement": "<string>",
              "events": "<string>",
              "expired_card": "<string>",
              "files": "<string>",
              "import": "<string>",
              "integration_bank_accounts": "<string>",
              "integration_transactions": "<string>",
              "integrations": "<string>",
              "invoices": "<string>",
              "journal_accounts": "<string>",
              "journal_entries": "<string>",
              "logs": "<string>",
              "objects": "<string>",
              "one_time": "<string>",
              "payments": "<string>",
              "pricing": "<string>",
              "promotions": "<string>",
              "proposal": "<string>",
              "reports": "<string>",
              "sales_users": "<string>",
              "settings": "<string>",
              "subscriptions": "<string>",
              "team": "<string>",
              "webhooks": "<string>"
            },
            "company_id": "<string>",
            "company_name": "<string>",
            "id": "<string>",
            "image_url": "<string>",
            "role": "<string>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "id": "<string>",
        "is_super_user": true,
        "maple_employee_role": "<string>",
        "name": "<string>",
        "otp_enabled": true,
        "updated_at": "2023-11-07T05:31:56Z",
        "verified": true
      }
    },
    "company_user_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "display_email": "<string>",
    "display_name": "<string>",
    "email": "<string>",
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "sales_user_id": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "term": {
    "count": 123
  },
  "trial": true,
  "trial_conversion_date": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

​
company_id
string
required

The company ID with the prefix 'cmp_'.

​
id
string
required

The resource ID

Body

application/json

The change configuration for subscription

​
config_items
object[]
required

The mapping of the product metric pricings to their quantity

​
product_pricing_ids
string[]
required

The list of product pricings that form the subscription

​
proration_type
enum<string>
required

This is one of NEXT, IMMEDIATE or NONE based on whether the proration is charged on the next invoice, immediately or no proration is applied respectively

Available options:
NEXT,
IMMEDIATE,
NONE
​
timing
enum<string>
required

This is one of IMMEDIATE, PERIOD_END, RENEWAL or CUSTOM based on whether the change timing needs to be immediate, at the end of the current period, on renewal, or at a custom date respectively

Available options:
IMMEDIATE,
PERIOD_END,
RENEWAL,
CUSTOM
​
auto_charges
null | boolean

Whether the subscription is automatically charged to the payment method

​
auto_renews
null | boolean

Whether the subscription is automatically renewing

​
custom_change_date
null | string<date-time>

The custom change date for the change if the timing is set to CUSTOM. This will be ignored otherwise

​
discounts
object[] | null

The discounts attached to the change. If no discounts are sent, the original discounts on the subscription will remain

​
metadata
object

Any additional data as key-value pairs that needs to be attached to the changed subscription

​
minimum_spend
object

The minimum amount of spend that needs to be attached to the subscription

​
onetime_items
object[] | null

Any one time charges to be attached to the change

​
payment_method_id
null | string

The payment method for the subscription on change

​
reset_billing_anchor
null | boolean

Whether to reset the billing anchor of the subscription

​
term
object

The term for the subscription, defaults to the largest product pricing frequency

​
trial
null | boolean

Whether the subscription is a trial

​
trial_term
object

The term which includes a frequency interval and a count for number of intervals

Response

200 - application/json

OK

​
arr
object

The annual recurring revenue for this subscription

​
auto_charges
boolean

Whether the subscription is set up to automatically charge the card attached to the subscription or the default payment method on the customer

​
auto_renews
boolean

Whether the subscription is set up to automatically renew

​
billing_anchor_date
string<date-time>

The billing anchor date for this subscription, typically the same as the start date

​
cancel_config
object

Any cancel request information for this subscription

​
cancel_date
null | string<date-time>

The date this subscription was cancelled. The end date represents the date that the subscription will actually cancel

​
change_config
object

Any change request information for this subscription

​
change_date
null | string<date-time>

The date this subscription is due to change to a different plan

​
company_id
string

The company ID of the subscription

​
computed_entitlements
object[] | null

Computed entitlements attached to this subscription

​
config_items
object[] | null

The mapping of the quantities and the product metric pricings

​
created_at
string<date-time>

The date the subscription was created

​
customer
object

The expanded customer details for the subscription

​
customer_id
string

The customer to which this subscription belongs

​
end_date
null | string<date-time>

The end date of the subscription, if there is one

​
id
string

The ID of the subscription in Measure

​
invoice_additional_display_fields
object[] | null

Any additional invoice key-value pairs that attached to the invoices for this subscription

​
invoice_due_date_from_creation
integer

The number of days between the invoice date and the due date

Required range: x >= 0
​
metadata
object

Any additional data as key-value pairs attached to the subscription

​
minimum_spend
object

The minimum spend for this subscription per billing period

​
mrr
object

The monthly recurring revenue for this subscription

​
next_invoice_date
null | string<date-time>

The date the next invoice for this subscription will be available

​
override_entitlements
object[] | null

Any entitlements attached to this subscription

​
pause_config
object

Any pause request information for this subscription

​
pause_date
null | string<date-time>

The date this subscription was paused for collection

​
payment_method_id
null | string

The payment method for this subscription, if available

​
product_pricing_ids
string[] | null

The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan

​
product_pricings
object[] | null

The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan

​
renewal_date
null | string<date-time>

The renewal date of the subscription, if there is one

​
sales_user
object

The commissionable user if there is one present

​
sales_user_id
null | string

The ID of the commissionable user if there is one present

​
start_date
string<date-time>

The start date of the subscription

​
status
string

The subscription status which can be one of active, cancelled or unpaid

​
term
object

The term for the subscription, broken into the intervals and the number of intervals

​
trial
boolean

Whether the subscription is a trial

​
trial_conversion_date
null | string<date-time>

The date the trial converted to an active subscription, remains null if trial does not convert

​
updated_at
string<date-time>

The date the subscription was last updated