On this page
No Headings
Product variants such as size, color, or material presented to customers during checkout. Each variant (e.g., "Size") can have up to 10 options (e.g., "S", "M", "L", "XL"). Supports up to 5 variants total. One variant can be designated as primary to enable different prices per option.
objectdimensionsrequiredarrayList of variant dimensions available for this product. Each dimension can have multiple options.
itemsobjectVariant dimension structure with multiple options. Each variant can have multiple options, and only one variant can be marked as primary.
namerequiredstring^.*$The name of the variant dimension (e.g., "Size", "Color").
primaryrequiredbooleanOnly one dimension has primary set to true. Only options in the primary dimension can have unit_amount.
optionsrequiredarrayList of option available.
itemsobjectOption available for the item.
labelrequiredstring^.*$The display label for this option (e.g., "Large").
unit_amountobjectUnit Price of this option, including value and currency code.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.