The Product object

Attributes

id string Unique identifier for the object.
active boolean Whether the product is currently available for purchase.
default _ price nullable string Expandable The ID of the Price object that is the default price for this product.
description nullable 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.
metadata map 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.
tax _ code nullable string Expandable A tax code ID.
tax _ details nullable object Preview feature Tax details for this product, including the tax code and an optional performance location.

More attributes

object string, value is "product"
created timestamp
images array of strings
livemode boolean
marketing _ features array of objects
package _ dimensions nullable object
shippable nullable boolean
statement _ descriptor nullable string
unit _ label nullable string
updated timestamp
url nullable string

The Product object

{ "id": "prod_NWjs8kKbJWmuuc", "object": "product", "active": true, "created": 1678833149, "default_price": null, "description": null, "images": [], "marketing_features": [], "livemode": false, "metadata": {}, "name": "Gold Plan", "package_dimensions": null, "shippable": null, "statement_descriptor": null, "tax_code": null, "unit_label": null, "updated": 1678833149, "url": null}

Create a product

POST / v1 / products

Creates a new product object.

Parameters

name string Required The product’s name, meant to be displayable to the customer.
active boolean Whether the product is currently available for purchase. Defaults to true.
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 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.
metadata map 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.
tax _ code string Recommended if calculating taxes A tax code ID.
tax _ details object Recommended if calculating taxes Preview feature Tax details for this product, including the tax code and an optional performance location.

More parameters

default _ price _ data object
images array of strings
marketing _ features array of objects
package _ dimensions object
shippable boolean
statement _ descriptor string
unit _ label string
url string

Returns

Returns a product object if the call succeeded.

Response

{ "id": "prod_NWjs8kKbJWmuuc", "object": "product", "active": true, "created": 1678833149, "default_price": null, "description": null, "images": [], "marketing_features": [], "livemode": false, "metadata": {}, "name": "Gold Plan", "package_dimensions": null, "shippable": null, "statement_descriptor": null, "tax_code": null, "unit_label": null, "updated": 1678833149, "url": null}

Update a product

POST / v1 / products /:id

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

Parameters

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 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.
metadata map 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.
tax _ code string Recommended if calculating taxes A tax code ID.
tax _ details object Recommended if calculating taxes Preview feature Tax details for this product, including the tax code and an optional performance location.

More parameters

images array of strings
marketing _ features array of objects
package _ dimensions object
shippable boolean
statement _ descriptor string
unit _ label string
url string

Returns

Returns the product object if the update succeeded.

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}