Defines the object schema located at components.schemas.product in the specification.
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 to configure pricing in Payment Links, Checkout, and Subscriptions.
Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices
Constructors
ProductproductActive :: Boolactive: Whether the product is currently available for purchase.
productCreated :: Intcreated: Time at which the object was created. Measured in seconds since the Unix epoch.
productDefaultPrice :: Maybe (Nullable ProductDefaultPrice'NonNullableVariants)default_price: The ID of the Price object that is the default price for this product.
productDescription :: Maybe (Nullable Text)description: 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.
Constraints:
Maximum length of 5000
productId :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
productImages :: [Text]images: A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
productLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
productMetadata :: Objectmetadata: 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.
productName :: Textname: The product's name, meant to be displayable to the customer.
Constraints:
Maximum length of 5000
productPackageDimensions :: Maybe (Nullable ProductPackageDimensions'NonNullable)package_dimensions: The dimensions of this product for shipping purposes.
productShippable :: Maybe (Nullable Bool)shippable: Whether this product is shipped (i.e., physical goods).
productStatementDescriptor :: Maybe (Nullable Text)statement_descriptor: 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.
Constraints:
Maximum length of 5000
productTaxCode :: Maybe (Nullable ProductTaxCode'NonNullableVariants)tax_code: A tax code ID.
productUnitLabel :: Maybe (Nullable Text)unit_label: A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
Constraints:
Maximum length of 5000
productUpdated :: Intupdated: Time at which the object was last updated. Measured in seconds since the Unix epoch.
productUrl :: Maybe (Nullable Text)url: A URL of a publicly-accessible webpage for this product.
Constraints:
Maximum length of 2048