Object Index / Definition

You are viewing an old version of the API
Order​Line​Item​Modifier

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 referencing CatalogModifier.

Max Length 192
name
string

The name of the item modifier.

Max Length 255
total_price_money
Money

Read only The total price of the item modifier for its line item. This is the modifier's base_price_money multiplied by the line item's quantity.

uid
string

Beta

Unique ID that identifies the modifier only within this order.

Max Length 60

Share Feedback

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