/v1/products/{id}Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
| Name | Description |
|---|---|
| id* |
| Field | Type | Description |
|---|---|---|
| active | boolean | Whether the product is available for purchase. |
| default_price | string | The ID of the Price object that is the default price for this product. |
| description | string | string | 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. |
| expand | array<string> | Specifies which fields in the response should be expanded. |
| images | array<string> | string | A list of up to 8 URLs of images for this product, meant to be displayable to the customer. |
| marketing_features | array<object> | string | A list of up to 15 marketing features for this product. These are displayed in pricing tables. |
| metadata | object | string | 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
| name | string | The product's name, meant to be displayable to the customer. |
| package_dimensions | object | string | The dimensions of this product for shipping purposes. |
| shippable | boolean | Whether this product is shipped (i.e., physical goods). |
| statement_descriptor | string | 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 |
| tax_code | string | string | A tax code ID. |
| unit_label | string | string | 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 |
| url | string | string | A URL of a publicly-accessible webpage for this product. |
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| active* | boolean | Whether the product is currently available for purchase. | ||||||
| created* | integer (unix-time) | Time at which the object was created. Measured in seconds since the Unix epoch. | ||||||
| default_price | string | price | The ID of the Price object that is the default price for this product. | ||||||
| description | string | 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. | ||||||
| id* | string | Unique identifier for the object. | ||||||
| images* | array<string> | A list of up to 8 URLs of images for this product, meant to be displayable to the customer. | ||||||
| livemode* | boolean | If the object exists in live mode, the value is | ||||||
| marketing_features* | array<product_marketing_feature> | A list of up to 15 marketing features for this product. These are displayed in pricing tables. array item fields
| ||||||
| metadata* | object | 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. | ||||||
| name* | string | The product's name, meant to be displayable to the customer. | ||||||
| object* | string | String representing the object's type. Objects of the same type share the same value. | ||||||
| package_dimensions | package_dimensions | The dimensions of this product for shipping purposes. | ||||||
| shippable | boolean | Whether this product is shipped (i.e., physical goods). | ||||||
| statement_descriptor | string | 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_code | string | tax_code | A tax code ID. | ||||||
| unit_label | string | A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. | ||||||
| updated* | integer (unix-time) | Time at which the object was last updated. Measured in seconds since the Unix epoch. | ||||||
| url | string | A URL of a publicly-accessible webpage for this product. |