Products
post/v1/products

Create a product

Creates a new product object.

Request body

FieldTypeDescription
activeboolean

Whether the product is currently available for purchase. Defaults to true.

default_price_dataobject

Data used to generate a new Price object. This Price will be set as the default price for this product.

8 nested fields
FieldTypeDescription
currency*string (currency)
currency_optionsobject
custom_unit_amountobject
4 nested fields
FieldTypeDescription
enabled*boolean
maximuminteger
minimuminteger
presetinteger
metadataobject
recurringobject
2 nested fields
FieldTypeDescription
interval*string
interval_countinteger
tax_behaviorstring
unit_amountinteger
unit_amount_decimalstring (decimal)
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.

expandarray<string>

Specifies which fields in the response should be expanded.

idstring

An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.

imagesarray<string>

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

marketing_featuresarray<object>

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

array item fields
FieldTypeDescription
name*string
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.

name*string

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

package_dimensionsobject

The dimensions of this product for shipping purposes.

4 nested fields
FieldTypeDescription
height*number
length*number
weight*number
width*number
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. Only used for subscription payments.

tax_codestring

A tax code ID.

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.

urlstring

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

Response

FieldTypeDescription
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_pricestring | price

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.

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 true. If the object exists in test mode, the value is false.

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
FieldTypeDescription
namestring

The marketing feature name. Up to 80 characters long.

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_dimensionspackage_dimensions

The dimensions of this product for shipping purposes.

shippableboolean

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

statement_descriptorstring

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_codestring | tax_code

A tax code ID.

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.

updated*integer (unix-time)

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

urlstring

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