Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
Product

Update a product

Updates a product information

put/api/v1/products/{id}

Path parameters

idstring required

Request body

namestring required

The name of the product. Displayed on the checkout page

descriptionstring

The description of the product. Displayed on the checkout page

isActiveboolean

Whether the product is currently active

imagesstring[]

The url of product images. Displayed on the checkout page

unitLabelstring

The label of the unit of the product. Displayed on the checkout page

urlstring

The url of the product

metadataobject

The metadata of the product

visibilitystring
defaultPriceIdstring uuid required

Product's default price id

Example request

{
  "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
}

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
namestring required

The name of the product. Displayed on the checkout page

descriptionstring

The description of the product. Displayed on the checkout page

isActiveboolean

Whether the product is currently active

imagesstring[]

The url of product images. Displayed on the checkout page

publicImagesstring[]

Product images with absolute public url

unitLabelstring

The label of the unit of the product. Displayed on the checkout page

urlstring

The url of the product

defaultPriceIdstring uuid

Product's default price id

metadataobject

The metadata of the product

visibilitystring

Example response

{
  "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
  "defaultPrice": {
    "productId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
    "intervalCount": 1,
    "product": {
      "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
    }
  }
}