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 } ]}
Delete a product
DELETE / v1 / products /:id
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
Parameters
No parameters.
Returns
Returns a deleted object on success. Otherwise, this call raises an error.
Response
{ "id": "prod_NWjs8kKbJWmuuc", "object": "product", "deleted": true}