Object Index / Definition

You are viewing an old version of the API
PaymentItemization
V1

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

Payment include anitemizations field that lists the items purchased, along with associated fees, modifiers, and discounts.

Properties

Name Description
name
string

The item's name.

quantity
number

The quantity of the item purchased. This can be a decimal value.

itemization_type
string

The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See V1PaymentItemizationItemizationType for possible values

item_detail
PaymentItemDetail

Details of the item, including its unique identifier and the identifier of the item variation purchased.

notes
string

Notes entered by the merchant about the item at the time of payment, if any.

item_variation_name
string

The name of the item variation purchased, if any.

total_money
Money

The total cost of the item, including all taxes and discounts.

single_quantity_money
Money

The cost of a single unit of this item.

gross_sales_money
Money

The total cost of the itemization and its modifiers, not including taxes or discounts.

discount_money
Money

The total of all discounts applied to the itemization. This value is always negative or zero.

net_sales_money
Money

The sum of grosssalesmoney and discount_money.

taxes
PaymentTax [ ]

All taxes applied to this itemization.

discounts
PaymentDiscount [ ]

All discounts applied to this itemization.

modifiers
PaymentModifier [ ]

All modifier options applied to this itemization.

Share Feedback

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