POST /v1/products/{id}

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

Servers

Path parameters

Name Type Required Description
id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
description No

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.

tax_code No

A tax code ID.

url No

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

expand[] Array No

Specifies which fields in the response should be expanded.

metadata No

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.

default_price String No

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

unit_label No

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.

package_dimensions No

The dimensions of this product for shipping purposes.

marketing_features No

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

name String No

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

active Boolean No

Whether the product is available for purchase.

images No

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

statement_descriptor String No

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.

shippable Boolean No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.