Skip to main content
PATCH
Update Product

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