Sample - Stripe API
POST/v1/products/{id}

Update a product

Updates a product by changing only the fields you provide. Use the form fields to modify availability, pricing, customer-facing content, shipping details, tax information, or product metadata; omitted fields remain unchanged.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 14 body fields
idstringrequired
The unique identifier of the product to update. Must be no longer than 5000 characters.

Optional product fields to update; omitted fields retain their current values.

activebooleanoptional
Whether the product is available for purchase.
default_pricestringoptional
The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.
descriptionstringoptional
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.
expandarray<string>optional
Specifies which fields in the response should be expanded.
imagesarray<string>optional
A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
marketing_featuresarray<Features>optional
A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
namestringoptional
The product's name, meant to be displayable to the customer.
package_dimensionsobjectoptional
The dimensions of this product for shipping purposes.
shippablebooleanoptional
Whether this product is shipped (i.e., physical goods).
statement_descriptorstringoptional
An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
tax_codestringoptional
A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
unit_labelstringoptional
A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
urlstringoptional
A URL of a publicly-accessible webpage for this product.

2 status codes
200Returns the updated product object, including its identifier, availability, name, images, metadata, and other current product attributes.
activebooleanrequired
Whether the product is currently available for purchase.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
default_pricestringoptional
The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.
descriptionstringoptional
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.
idstringrequired
Unique identifier for the object.
imagesarray<string>required
A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
marketing_featuresarray<ProductMarketingFeature>required
A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringrequired
The product's name, meant to be displayable to the customer.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:product
package_dimensionsobjectoptional
The dimensions of this product for shipping purposes.
shippablebooleanoptional
Whether this product is shipped (i.e., physical goods).
statement_descriptorstringoptional
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.
tax_codestringoptional
A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
unit_labelstringoptional
A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
updatedintegerrequired
Time at which the object was last updated. Measured in seconds since the Unix epoch.
urlstringoptional
A URL of a publicly-accessible webpage for this product.
defaultError response.
errorobjectrequired

Error handling

id must be a product identifier no longer than 5000 characters. Any supplied field must satisfy its schema constraints, including maximum lengths for name, description, statement_descriptor, and unit_label, and the limit of 8 items in images.