v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Update a product

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post/v1/products/{id}

Path parameters

idstring required

Response

Successful response.

activeboolean required

Whether the product is currently available for purchase.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

descriptionstring nullable

The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

idstring required

Unique identifier for the object.

imagesstring[] required

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

namestring required

The product's name, meant to be displayable to the customer.

object'product' required

String representing the object's type. Objects of the same type share the same value.

shippableboolean nullable

Whether this product is shipped (i.e., physical goods).

statement_descriptorstring nullable

Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.

unit_labelstring nullable

A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

updatedinteger required

Time at which the object was last updated. Measured in seconds since the Unix epoch.

urlstring nullable

A URL of a publicly-accessible webpage for this product.