Update Subscription
Update the properties of the subscription by ID with the provided details. Note: The subscription product pricing can not be changed with this endpoint. Please refer to /change to make plan changes.
curl --request PATCH \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"auto_charges": true,
"invoice_additional_display_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"invoice_due_date_from_creation": 1,
"invoice_payment_instructions": "<string>",
"metadata": {},
"minimum_spend": {
"currency": "<string>",
"value_in_cents": 123
},
"override_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"key": "<string>",
"value": "<unknown>"
}
],
"parent_billed": true,
"payment_method_id": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}"
payload = {
"auto_charges": True,
"invoice_additional_display_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"invoice_due_date_from_creation": 1,
"invoice_payment_instructions": "<string>",
"metadata": {},
"minimum_spend": {
"currency": "<string>",
"value_in_cents": 123
},
"override_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"key": "<string>",
"value": "<unknown>"
}
],
"parent_billed": True,
"payment_method_id": "<string>",
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auto_charges: true,
invoice_additional_display_fields: [{name: '<string>', value: '<string>'}],
invoice_due_date_from_creation: 1,
invoice_payment_instructions: '<string>',
metadata: {},
minimum_spend: {currency: '<string>', value_in_cents: 123},
override_entitlements: [
{
entitlement_id: '<string>',
id: '<string>',
key: '<string>',
value: '<unknown>'
}
],
parent_billed: true,
payment_method_id: '<string>',
tags: ['<string>']
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'auto_charges' => true,
'invoice_additional_display_fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'invoice_due_date_from_creation' => 1,
'invoice_payment_instructions' => '<string>',
'metadata' => [
],
'minimum_spend' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'override_entitlements' => [
[
'entitlement_id' => '<string>',
'id' => '<string>',
'key' => '<string>',
'value' => '<unknown>'
]
],
'parent_billed' => true,
'payment_method_id' => '<string>',
'tags' => [
'<string>'
]
]),
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}"
payload := strings.NewReader("{\n \"auto_charges\": true,\n \"invoice_additional_display_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"minimum_spend\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"override_entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"parent_billed\": true,\n \"payment_method_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"auto_charges\": true,\n \"invoice_additional_display_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"minimum_spend\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"override_entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"parent_billed\": true,\n \"payment_method_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auto_charges\": true,\n \"invoice_additional_display_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"minimum_spend\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"override_entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"parent_billed\": true,\n \"payment_method_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
The company ID with the prefix 'cmp_'.
The resource ID
Body
The update configuration for subscription's properties'
Whether the subscription is automatically charged to the payment method
Any additional invoice key-value pairs that attached to the invoices for this subscription
Show child attributes
Show child attributes
The number of days between the invoice date and the due date for any invoices created for this subscription
x >= 0HTML formatted payment instructions attached to each invoice generated for the subscription. If non-null, overrides the invoice payment instructions set at the company-wide setting.
Any additional data as key-value pairs that needs to be attached to the subscription
The minimum amount of spend that needs to be attached to the subscription
Show child attributes
Show child attributes
The entitlements that will override product and product pricing entitlements
Show child attributes
Show child attributes
Whether the subscription is billed to a parent customer
The payment method for the subscription on change
Any tags that needs to be attached to the subscription
Response
OK
The annual recurring revenue for this subscription
Show child attributes
Show child attributes
Whether the subscription is set up to automatically charge the card attached to the subscription or the default payment method on the customer
Whether the subscription is set up to automatically renew
The billing anchor date for this subscription, typically the same as the start date
Any cancel request information for this subscription
Show child attributes
Show child attributes
The date this subscription was cancelled. The end date represents the date that the subscription will actually cancel
Any change request information for this subscription
Show child attributes
Show child attributes
The date this subscription is due to change to a different plan
The company ID of the subscription
Computed entitlements attached to this subscription
Show child attributes
Show child attributes
The mapping of the quantities and the product metric pricings
Show child attributes
Show child attributes
The date the subscription was created
The expanded customer details for the subscription
Show child attributes
Show child attributes
The customer to which this subscription belongs
The end date of the subscription, if there is one
The ID of the subscription in Measure
Any additional invoice key-value pairs that attached to the invoices for this subscription
Show child attributes
Show child attributes
The number of days between the invoice date and the due date
x >= 0Any additional data as key-value pairs attached to the subscription
The minimum spend for this subscription per billing period
Show child attributes
Show child attributes
The monthly recurring revenue for this subscription
Show child attributes
Show child attributes
The date the next invoice for this subscription will be available
Any entitlements attached to this subscription
Show child attributes
Show child attributes
Any pause request information for this subscription
Show child attributes
Show child attributes
The date this subscription was paused for collection
The payment method for this subscription, if available
The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan
The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan
Show child attributes
Show child attributes
The renewal date of the subscription, if there is one
The commissionable user if there is one present
Show child attributes
Show child attributes
The ID of the commissionable user if there is one present
The start date of the subscription
The subscription status which can be one of active, cancelled or unpaid
The term for the subscription, broken into the intervals and the number of intervals
Show child attributes
Show child attributes
Whether the subscription is a trial
The date the trial converted to an active subscription, remains null if trial does not convert
The date the subscription was last updated
curl --request PATCH \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"auto_charges": true,
"invoice_additional_display_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"invoice_due_date_from_creation": 1,
"invoice_payment_instructions": "<string>",
"metadata": {},
"minimum_spend": {
"currency": "<string>",
"value_in_cents": 123
},
"override_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"key": "<string>",
"value": "<unknown>"
}
],
"parent_billed": true,
"payment_method_id": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}"
payload = {
"auto_charges": True,
"invoice_additional_display_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"invoice_due_date_from_creation": 1,
"invoice_payment_instructions": "<string>",
"metadata": {},
"minimum_spend": {
"currency": "<string>",
"value_in_cents": 123
},
"override_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"key": "<string>",
"value": "<unknown>"
}
],
"parent_billed": True,
"payment_method_id": "<string>",
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auto_charges: true,
invoice_additional_display_fields: [{name: '<string>', value: '<string>'}],
invoice_due_date_from_creation: 1,
invoice_payment_instructions: '<string>',
metadata: {},
minimum_spend: {currency: '<string>', value_in_cents: 123},
override_entitlements: [
{
entitlement_id: '<string>',
id: '<string>',
key: '<string>',
value: '<unknown>'
}
],
parent_billed: true,
payment_method_id: '<string>',
tags: ['<string>']
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'auto_charges' => true,
'invoice_additional_display_fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'invoice_due_date_from_creation' => 1,
'invoice_payment_instructions' => '<string>',
'metadata' => [
],
'minimum_spend' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'override_entitlements' => [
[
'entitlement_id' => '<string>',
'id' => '<string>',
'key' => '<string>',
'value' => '<unknown>'
]
],
'parent_billed' => true,
'payment_method_id' => '<string>',
'tags' => [
'<string>'
]
]),
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}"
payload := strings.NewReader("{\n \"auto_charges\": true,\n \"invoice_additional_display_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"minimum_spend\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"override_entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"parent_billed\": true,\n \"payment_method_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"auto_charges\": true,\n \"invoice_additional_display_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"minimum_spend\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"override_entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"parent_billed\": true,\n \"payment_method_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auto_charges\": true,\n \"invoice_additional_display_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"minimum_spend\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"override_entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"parent_billed\": true,\n \"payment_method_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\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"
}
