Skip to main content
PATCH
/
companies
/
{company_id}
/
products
/
{id}
Update Product
curl --request PATCH \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounting_integration_mapping": {},
  "description": "<string>",
  "entitlements": [
    {
      "entitlement_id": "<string>",
      "id": "<string>",
      "key": "<string>",
      "value": "<unknown>"
    }
  ],
  "external_name": "<string>",
  "gl_code": "<string>",
  "image_url": "<string>",
  "metadata": {},
  "name": "<string>",
  "state": "<string>",
  "tags": [
    "<string>"
  ],
  "tax_calc_integration_mapping": {}
}
'
import requests

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

payload = {
"accounting_integration_mapping": {},
"description": "<string>",
"entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"key": "<string>",
"value": "<unknown>"
}
],
"external_name": "<string>",
"gl_code": "<string>",
"image_url": "<string>",
"metadata": {},
"name": "<string>",
"state": "<string>",
"tags": ["<string>"],
"tax_calc_integration_mapping": {}
}
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({
accounting_integration_mapping: {},
description: '<string>',
entitlements: [
{
entitlement_id: '<string>',
id: '<string>',
key: '<string>',
value: '<unknown>'
}
],
external_name: '<string>',
gl_code: '<string>',
image_url: '<string>',
metadata: {},
name: '<string>',
state: '<string>',
tags: ['<string>'],
tax_calc_integration_mapping: {}
})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/products/{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}/products/{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([
'accounting_integration_mapping' => [

],
'description' => '<string>',
'entitlements' => [
[
'entitlement_id' => '<string>',
'id' => '<string>',
'key' => '<string>',
'value' => '<unknown>'
]
],
'external_name' => '<string>',
'gl_code' => '<string>',
'image_url' => '<string>',
'metadata' => [

],
'name' => '<string>',
'state' => '<string>',
'tags' => [
'<string>'
],
'tax_calc_integration_mapping' => [

]
]),
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}/products/{id}"

payload := strings.NewReader("{\n \"accounting_integration_mapping\": {},\n \"description\": \"<string>\",\n \"entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"external_name\": \"<string>\",\n \"gl_code\": \"<string>\",\n \"image_url\": \"<string>\",\n \"metadata\": {},\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"tax_calc_integration_mapping\": {}\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}/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accounting_integration_mapping\": {},\n \"description\": \"<string>\",\n \"entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"external_name\": \"<string>\",\n \"gl_code\": \"<string>\",\n \"image_url\": \"<string>\",\n \"metadata\": {},\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"tax_calc_integration_mapping\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/products/{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 \"accounting_integration_mapping\": {},\n \"description\": \"<string>\",\n \"entitlements\": [\n {\n \"entitlement_id\": \"<string>\",\n \"id\": \"<string>\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"external_name\": \"<string>\",\n \"gl_code\": \"<string>\",\n \"image_url\": \"<string>\",\n \"metadata\": {},\n \"name\": \"<string>\",\n \"state\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"tax_calc_integration_mapping\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}

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
accounting_integration_mapping
object | null
description
null | string

The description of the product

entitlements
null | object[]

The entitlements that enable features for the product

external_name
null | string

The external name of the product

gl_code
string | null

The GL code for the product

image_url
string | null

The url for the image of the product

metadata
object

Any additional data as key-value pairs that need to be attached to the product

name
null | string

The name of the product

state
null | string

The state of the product such as ACTIVE or ARCHIVED

tags
null | string[]

Any string tags associated with this product

tax_calc_integration_mapping
object | null

Response

200 - application/json

OK

company_id
string

The company ID of the product

created_at
string<date-time>

The date the product was created

description
string

The description of the product

entitlements
object[] | null

The entitlements that enable features for the product

external_name
string

The external name of the product

gl_code
null | string

The GL code for the product

id
string

The ID of the product in Measure

image_url
null | string

The url for the image of the product

import_created_at_ref
null | string<date-time>

The date the product was created in the import source

import_ref
null | string

The import reference ID for the product

imported_from
null | string

Where the product is imported from

metadata
object

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

name
string

The name of the product

num_subs
integer

The number of subscriptions in the company with the product

Required range: x >= 0
product_pricings
object[] | null

The product prices attached to this product

state
string

The state of the product such as ACTIVE or ARCHIVED

tags
string[] | null

Any tags on the product

updated_at
string<date-time>

The date the product was last updated