Object Index / Definition

You are viewing an old version of the API
Modifier​Option
V1

Note We recommend using the Square API (V2) for all new development when possible.

Deprecated

V1ModifierOption

Properties

Name Description
id
string

The modifier option's unique ID.

modifier_list_id
string

The ID of the modifier list the option belongs to.

name
string

The modifier option's name.

on_by_default
boolean

If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.

ordinal
integer

Indicates the modifier option's list position when displayed in Square Point of Sale and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.

price_money
V1​Money

The modifier option's price.

v2_id
string

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Share Feedback

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