PUT
/
v1
/
products
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

Body

application/json
name
string
required

Product name.

description
string | null

Product description.

public_description
string | null

Public description of the product.

translations
object | null

Product name and description translations.

is_available_on_demand
boolean
is_available_on_subscription
boolean
properties
object | null
custom_properties
object

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

accounting
object

Mapping invoicing entity ID/accounting settings.

Response

200 - application/json
id
string
required

Product ID.

type
enum<string>
required
Available options:
flat_fee
name
string
required

Product name.

description
string | null
required

Product description.

description_display_interval_dates
boolean
required

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

public_description
string | null
required

Public description of the product.

translations
object | null
required

Product name and description translations.

properties
object | null
required

Key/value pairs to store any information you find useful.

custom_properties
object
required

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

accounting
object
required

Mapping invoicing entity ID/accounting settings.

is_available_on_demand
boolean
required

Enable the product to be billed at any time as a one-time payment.

is_available_on_subscription
boolean
required

Enable the product to be added as part of a subscription.

price_configurations
object[]
required

Was this page helpful?

Get productGet quotes