Object Index / Definition

You are viewing an old version of the API
Create​Order​Request​Modifier

Deprecated

Please use the OrderLineItemModifier type instead

Represents a modifier applied to a single line item.

Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price.

Properties

Name Description
base_price_money
Money

The base price for the modifier.

base_price_money is required for ad hoc modifiers. If both catalog_object_id and base_price_money are set, base_price_money will override the predefined CatalogModifier price.

catalog_object_id
string

The catalog object ID of a CatalogModifier.

Max Length 192
name
string

Only used for ad hoc modifiers. The name of the modifier. name cannot exceed 255 characters.

Do not provide a value for name if you provide a value for catalog_object_id.

Max Length 255

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?