Sign in
Products

Update product

Update the details of an existing product.

put/v1/products/{id}

Path parameters

idstring required

Request body

namestring required

Product name.

descriptionstring nullable

Product description.

public_descriptionstring nullable

Public description of the product.

translationsobject nullable

Product name and description translations.

is_available_on_demandboolean
is_available_on_subscriptionboolean
propertiesobject nullable
custom_propertiesobject

A list of key value with the slug of the custom property as the key and the custom property value as value.

accountingProductAccounting

Mapping invoicing entity ID/accounting settings.

Example request

{
  "name": "Product name",
  "description": "Product internal description",
  "public_description": "Product public description"
}

Response

The newly created product

OR
OR
OR
ProductCredit required— unresolved $ref
OR

Example response

{
  "id": "itm_3kXODDF42QXtnL",
  "name": "Product name",
  "status": "active",
  "description": "Product internal description",
  "public_description": "Product public description",
  "integrations": [
    {
      "entity_id": "123456789",
      "provider_name": "stripe",
      "provider_account_id": "acc_1234567890"
    }
  ],
  "is_available_on_demand": true,
  "is_available_on_subscription": true,
  "price_configurations": [
    {
      "status": "active",
      "currency": "EUR",
      "country": "FR"
    }
  ]
}

Changes