Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Update a product 

Products
Products
Update a product

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

Parameters

  • activeboolean

    Whether the product is available for purchase.

  • default_pricestring

    The ID of the Price object that is the default price for this product.

  • descriptionstring

    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.

  • metadataobject

    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 metadata.

  • namestring

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

  • tax_codestringRecommended if calculating taxes

    A tax code ID.

More parameters

  • imagesarray of strings

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

  • marketing_featuresarray of objects

    A list of up to 15 marketing features for this product. These are displayed in pricing tables.

    • marketing_features.namestringRequired

      The marketing feature name. Up to 80 characters long.

  • package_dimensionsobject

    The dimensions of this product for shipping purposes.

    • package_dimensions.heightfloatRequired

      Height, in inches. Maximum precision is 2 decimal places.

    • package_dimensions.lengthfloatRequired

      Length, in inches. Maximum precision is 2 decimal places.

    • package_dimensions.weightfloatRequired

      Weight, in ounces. Maximum precision is 2 decimal places.

    • package_dimensions.widthfloatRequired

      Width, in inches. Maximum precision is 2 decimal places.

  • shippableboolean

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

  • statement_descriptorstring

    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.

  • unit_labelstring

    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.

  • urlstring

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

Returns

Returns the product object if the update succeeded.

POST /v1/products/:id
curl https://api.stripe.com/v1/products/prod_NWjs8kKbJWmuuc \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "metadata[order_id]"=6735
Response
{
  "id": "prod_NWjs8kKbJWmuuc",
  "object": "product",
  "active": true,
  "created": 1678833149,
  "default_price": null,
  "description": null,
  "images": [],
  "marketing_features": [],
  "livemode": false,
  "metadata": {
    "order_id": "6735"
  },
  "name": "Gold Plan",
  "package_dimensions": null,
  "shippable": null,
  "statement_descriptor": null,
  "tax_code": null,
  "unit_label": null,
  "updated": 1678833149,
  "url": null
}