Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

dimension_list

List of variant dimensions available for this product. Each dimension can have multiple options.

An array of dimension objects.

namestringRequired

The name of the variant dimension (e.g., "Size", "Color").

Match^.*$Length1 <= length <= 64

primarybooleanRequired

Only one dimension has primary set to true. Only options in the primary dimension can have unit_amount.

optionsobject<dimension_option>[]Required

List of option available.

Items1 <= length <= 10

dimension_option properties

2 properties

labelstringRequired

The display label for this option (e.g., "Large").

Match^.*$Length1 <= length <= 200

unit_amountobject<money>Optional

Unit Price of this option, including value and currency code.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

Back to top

dimension_list

List of variant dimensions available for this product. Each dimension can have multiple options.

An array of dimension objects.

namestringRequired

The name of the variant dimension (e.g., "Size", "Color").

Match^.*$Length1 <= length <= 64

primarybooleanRequired

Only one dimension has primary set to true. Only options in the primary dimension can have unit_amount.

optionsobject<dimension_option>[]Required

List of option available.

Items1 <= length <= 10

dimension_option properties

2 properties

labelstringRequired

The display label for this option (e.g., "Large").

Match^.*$Length1 <= length <= 200

unit_amountobject<money>Optional

Unit Price of this option, including value and currency code.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

dimension_list

dimension_option properties

money properties

Back to top

On this page

On this page

dimension_list

dimension_option properties

money properties

Back to top

On this page

dimension_list

dimension_option properties

money properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

dimension_list

dimension_option properties

money properties

Back to top

On this page