Stripe: Products schemas
7 Stripe schemas with complete fields and constraints.
← Products operations · All schemas
Create a product — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with [Prices](https://docs.stripe.com/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [share a Payment Link](https://docs.stripe.com/payment-links), [accept payments with Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront), and more about [Products and Prices](https://docs.stripe.com/products-prices/overview) |
active | boolean | Required within parent | Whether the product is currently available for purchase. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
default_price | JSON | Optional | |
default_price (anyOf 1) | JSON | Alternative | The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. |
default_price (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
default_price (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a price — response body |
default_price (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
images | array | Required within parent | A list of up to 8 URLs of images for this product, meant to be displayable to the customer. |
images[] | string | Each item | Maximum length: 5000 |
livemode | boolean | Required within parent | 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 | Required within parent | A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). |
marketing_features[] | Model | Each item | Expand Create a product — response body — marketing features item |
metadata | object | Required within parent | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
name | string | Required within parent | The product's name, meant to be displayable to the customer. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: product |
package_dimensions | JSON | Optional | |
package_dimensions (anyOf 1) | JSON | Alternative | The dimensions of this product for shipping purposes. |
package_dimensions (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a product — response body — package dimensions value height, length, weight, width |
package_dimensions (anyOf 2) | null | Alternative | |
shippable | JSON | Optional | |
shippable (anyOf 1) | boolean | Alternative | Whether this product is shipped (i.e., physical goods). |
shippable (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
statement_descriptor (anyOf 2) | null | Alternative | |
tax_code | JSON | Optional | |
tax_code (anyOf 1) | JSON | Alternative | A [tax code](https://docs.stripe.com/tax/tax-categories) ID. |
tax_code (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
tax_code (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a tax code — response body |
tax_code (anyOf 2) | null | Alternative | |
tax_details | JSON | Optional | |
tax_details (anyOf 1) | JSON | Alternative | Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location. |
tax_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a product — response body — tax details value performance location, tax code |
tax_details (anyOf 2) | null | Alternative | |
unit_label | JSON | Optional | |
unit_label (anyOf 1) | string | Alternative | A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. Maximum length: 5000 |
unit_label (anyOf 2) | null | Alternative | |
updated | JSON | Required within parent | |
updated (anyOf 1) | integer | Alternative | Time at which the object was last updated. Measured in seconds since the Unix epoch. Format: unix-time |
updated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | A URL of a publicly-accessible webpage for this product. Maximum length: 2048 |
url (anyOf 2) | null | Alternative |
Referenced models: Create a product — response body — package dimensions value height, length, weight, width, Create a price — response body, Create a product — response body — marketing features item, Retrieve a tax code — response body, Create a product — response body — tax details value performance location, tax code
Create a product — response body — marketing features item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The marketing feature name. Up to 80 characters long. Maximum length: 5000 |
Create a product — response body — package dimensions value height, length, weight, width
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
height | JSON | Required within parent | |
height (anyOf 1) | number | Alternative | Height, in inches. |
height (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
length | JSON | Required within parent | |
length (anyOf 1) | number | Alternative | Length, in inches. |
length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
weight | JSON | Required within parent | |
weight (anyOf 1) | number | Alternative | Weight, in ounces. |
weight (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
width | JSON | Required within parent | |
width (anyOf 1) | number | Alternative | Width, in inches. |
width (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a product — response body — tax details value performance location, tax code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tax details contains information about the data that was used to calculate taxes. |
performance_location | JSON | Optional | |
performance_location (anyOf 1) | string | Alternative | The ID of a tax location with type `performance`, representing where the performance takes place. Maximum length: 5000 |
performance_location (anyOf 2) | null | Alternative | |
tax_code | JSON | Optional | |
tax_code (anyOf 1) | string | Alternative | A [tax code](https://docs.stripe.com/tax/tax-categories) ID. Maximum length: 5000 |
tax_code (anyOf 2) | null | Alternative |
Delete a product — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Always true for a deleted object Known values: True |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: product |
Remove a feature from a product — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Always true for a deleted object Known values: True |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: product_feature |
Retrieve a product feature — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer. |
entitlement_feature | Model | Required within parent | Expand Create a feature — response body |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: product_feature |
Referenced models: Create a feature — response body