POST /v1/products
Creates a new product object.
Servers
- https://api.stripe.com/
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 |
String | 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 |
String | No |
A tax code ID. |
url |
String | No |
A URL of a publicly-accessible webpage for this product. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
Object | 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 |
unit_label |
String | No |
A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. |
package_dimensions |
Object | No |
The dimensions of this product for shipping purposes. |
package_dimensions.height |
Number | Yes | |
package_dimensions.length |
Number | Yes | |
package_dimensions.width |
Number | Yes | |
package_dimensions.weight |
Number | Yes | |
marketing_features[] |
Array | No |
A list of up to 15 marketing features for this product. These are displayed in pricing tables. |
marketing_features[].name |
String | Yes | |
id |
String | No |
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. |
name |
String | Yes |
The product's name, meant to be displayable to the customer. |
active |
Boolean | No |
Whether the product is currently available for purchase. Defaults to |
default_price_data |
Object | No |
Data used to generate a new Price object. This Price will be set as the default price for this product. |
default_price_data.unit_amount |
Integer | No | |
default_price_data.custom_unit_amount |
Object | No | |
default_price_data.custom_unit_amount.minimum |
Integer | No | |
default_price_data.custom_unit_amount.preset |
Integer | No | |
default_price_data.custom_unit_amount.enabled |
Boolean | Yes | |
default_price_data.custom_unit_amount.maximum |
Integer | No | |
default_price_data.unit_amount_decimal |
String | No | |
default_price_data.currency_options |
Object | No | |
default_price_data.currency_options.name |
Object | No | |
default_price_data.currency_options.name.unit_amount |
Integer | No | |
default_price_data.currency_options.name.custom_unit_amount |
Object | No | |
default_price_data.currency_options.name.custom_unit_amount.minimum |
Integer | No | |
default_price_data.currency_options.name.custom_unit_amount.preset |
Integer | No | |
default_price_data.currency_options.name.custom_unit_amount.enabled |
Boolean | Yes | |
default_price_data.currency_options.name.custom_unit_amount.maximum |
Integer | No | |
default_price_data.currency_options.name.tiers[] |
Array | No | |
default_price_data.currency_options.name.tiers[].unit_amount |
Integer | No | |
default_price_data.currency_options.name.tiers[].up_to |
Yes | ||
default_price_data.currency_options.name.tiers[].unit_amount_decimal |
String | No | |
default_price_data.currency_options.name.tiers[].flat_amount |
Integer | No | |
default_price_data.currency_options.name.tiers[].flat_amount_decimal |
String | No | |
default_price_data.currency_options.name.unit_amount_decimal |
String | No | |
default_price_data.currency_options.name.tax_behavior |
String | No |
Possible values:
|
default_price_data.metadata |
Object | No | |
default_price_data.recurring |
Object | No | |
default_price_data.recurring.interval |
String | Yes |
Possible values:
|
default_price_data.recurring.interval_count |
Integer | No | |
default_price_data.tax_behavior |
String | No |
Possible values:
|
default_price_data.currency |
String | Yes | |
images[] |
Array | 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 |
shippable |
Boolean | No |
Whether this product is shipped (i.e., physical goods). |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.