• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
PaymentItemization
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

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
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

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?