<- Object

Object

OrderLineItemTax

Represents a tax that applies to one or more line item in the order.

Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount the item contributes to the order subtotal.

Link to section

Properties

Link to section

uid

string

Beta

A unique ID that identifies the tax only within this order.

Link to section

catalog_object_id

string

Link to section

catalog_version

integer(64-bit)

The version of the catalog object that this tax references.

Link to section

name

string

The tax's name.

Link to section

type

string

Indicates the calculation method used to apply the tax.

Link to section

percentage

string

The percentage of the tax, as a string representation of a decimal number. For example, a value of "7.25" corresponds to a percentage of 7.25%.

Either percentage or amount_money should be set, but not both.

Link to section

metadata

Map<string, string>

Beta

Application-defined data attached to this tax. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Link to section

applied_money

The amount of money applied to the order by the tax.

  • For flat-amount taxes, applied_money is equal to amount_money.
  • For percentage-based taxes, applied_money is the money calculated using the percentage.
Link to section

scope

string

Indicates the level at which the tax applies. For ORDER scoped taxes, Square generates references in applied_taxes on all order line items that do not have them. For LINE_ITEM scoped taxes, the tax only applies to line items with references in their applied_taxes field.

This field is immutable. To change the scope, you must delete the tax and re-add it as a new tax.

Link to section

auto_applied

boolean

Beta