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}
Retrieve a product
GET / v1 / products /:id
Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
Parameters
No parameters.
Returns
Returns a product object if a valid identifier was provided.
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}
List all products
GET / v1 / products
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
Parameters
- active boolean Only return products that are active or inactive (e.g., pass
falseto list all inactive products).
More parameters
- created object
- ending _ before string
- ids array of strings
- limit integer
- shippable boolean
- starting _ after string
- url string
Returns
A dictionary with a data property that contains an array of up to limit products, starting after product starting_after. Each entry in the array is a separate product object. If no more products are available, the resulting array will be empty.
Response
{ "object": "list", "url": "/v1/products", "has_more": false, "data": [ { "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 } ]}