<- Object

Object

V1PaymentItemization

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

Each itemization has an itemization_type field that indicates which of the following the itemization represents:

  • An item variation from the merchant's item library

  • A custom monetary amount

An action performed on a Square gift card, such as activating or reloading it.

Note*: itemization information included in a Payment object reflects details collected at the time of the payment. Details such as the name or price of items might have changed since the payment was processed.

Link to section

Properties

Link to section

name

string

The item's name.

Link to section

quantity

number

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

Link to section

itemization_type

string

The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT

Link to section

item_detail

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

Link to section

notes

string

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

Link to section

item_variation_name

string

The name of the item variation purchased, if any.

Link to section

total_money

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

Link to section

single_quantity_money

The cost of a single unit of this item.

Link to section

gross_sales_money

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

Link to section

discount_money

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

Link to section

net_sales_money

The sum of gross_sales_money and discount_money.

Link to section

taxes

All taxes applied to this itemization.

Link to section

discounts

All discounts applied to this itemization.

Link to section

modifiers

All modifier options applied to this itemization.