Object Index
/ Definition
You are viewing an old version of the API
PaymentItemization
V1
Object Index / Definition
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
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.
Properties
| Name | Description |
|---|---|
discount_money
|
The total of all discounts applied to the itemization. This value is always negative or zero. |
discounts
|
All discounts applied to this itemization. |
gross_sales_money
|
The total cost of the itemization and its modifiers, not including taxes or discounts. |
item_detail
|
Details of the item, including its unique identifier and the identifier of the item variation purchased. |
item_variation_name
|
The name of the item variation purchased, if any. |
itemization_type
|
The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT |
modifiers
|
All modifier options applied to this itemization. |
name
|
The item's name. |
net_sales_money
|
The sum of grosssalesmoney and discount_money. |
notes
|
Notes entered by the merchant about the item at the time of payment, if any. |
quantity
|
The quantity of the item purchased. This can be a decimal value. |
single_quantity_money
|
The cost of a single unit of this item. |
taxes
|
All taxes applied to this itemization. |
total_money
|
The total cost of the item, including all taxes and discounts. |