Skip to main content
PUT
Update Product

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Body

product_id
string | null
Maximum string length: 250
product_name
string | null
Maximum string length: 250
product_description
string | null
Maximum string length: 250
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
currency
string | null
Maximum string length: 3
price
number<double> | null
Required range: -100000000000000 < x < 100000000000000
cost
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
exclude_from_mrr
boolean
is_taxable
boolean
is_renewable
boolean
recognize_revenue
boolean

If False, contract-sync skips the revenue-recognition waterfall for this product (no ContractSubscription / RevenueTransaction rows).

is_immediate_recognition
boolean

When true, revenue for this product is recognized in full on the invoice finalization date instead of being amortized over the service period. Used by the Stripe accrual JE waterfall.

stripe_product_id
string | null
Maximum string length: 250
avalara_item_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
avalara_item_data
unknown
avalara_tax_code
string | null

Avalara tax code (e.g., SW052000 for SAAS)

Maximum string length: 50
anrok_item_id
string | null
Maximum string length: 250
sphere_item_id
string | null
Maximum string length: 250
apply_dept_tag_to_invoice_journals
boolean | null

Apply Department and Tag categorization to all lines on Invoice Journals

department
integer | null
invoice_account
integer | null
revenue_account
integer | null
ar_account
integer | null
bad_debt_account
integer | null
invoice_unbilled_account
integer | null

Response

200 - application/json
id
integer
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
department_name
string
required
read-only
invoice_account_name
string | null
required
read-only
revenue_account_name
string | null
required
read-only
ar_account_name
string | null
required
read-only
bad_debt_account_name
string | null
required
read-only
invoice_unbilled_account_name
string | null
required
read-only
tax_account_name
string
required
read-only
tags
object[]
required
read-only
last_modified_at
string<date-time>
required
read-only
product_uuid
string<uuid>
required
read-only
display_name
string
required
read-only
usage_group_count
integer
default:0
required
read-only
usage_groups
object[]
required
read-only
created_at
string<date-time>
required
read-only
customer
integer
required
read-only
product_id
string | null
Maximum string length: 250
product_name
string | null
Maximum string length: 250
product_description
string | null
Maximum string length: 250
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
currency
string | null
Maximum string length: 3
price
number<double> | null
Required range: -100000000000000 < x < 100000000000000
cost
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
exclude_from_mrr
boolean
is_taxable
boolean
is_renewable
boolean
recognize_revenue
boolean

If False, contract-sync skips the revenue-recognition waterfall for this product (no ContractSubscription / RevenueTransaction rows).

is_immediate_recognition
boolean

When true, revenue for this product is recognized in full on the invoice finalization date instead of being amortized over the service period. Used by the Stripe accrual JE waterfall.

stripe_product_id
string | null
Maximum string length: 250
avalara_item_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
avalara_item_data
unknown
avalara_tax_code
string | null

Avalara tax code (e.g., SW052000 for SAAS)

Maximum string length: 50
anrok_item_id
string | null
Maximum string length: 250
sphere_item_id
string | null
Maximum string length: 250
apply_dept_tag_to_invoice_journals
boolean | null

Apply Department and Tag categorization to all lines on Invoice Journals

department
integer | null
invoice_account
integer | null
revenue_account
integer | null
ar_account
integer | null
bad_debt_account
integer | null
invoice_unbilled_account
integer | null