<- Object

Object

CatalogTax

A tax applicable to an item.

Link to section

Properties

Link to section

name

string

The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Link to section

calculation_phase

string

Whether the tax is calculated based on a payment's subtotal or total.

Show values
Link to section

inclusion_type

string

Whether the tax is ADDITIVE or INCLUSIVE.

Show values
Link to section

percentage

string

The percentage of the tax in decimal form, using a '.' as the decimal separator and without a '%' sign. A value of 7.5 corresponds to 7.5%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant.

Link to section

applies_to_custom_amounts

boolean

If true, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular CatalogItem.

Link to section

enabled

boolean

A Boolean flag to indicate whether the tax is displayed as enabled (true) in the Square Point of Sale app or not (false).

Link to section

applies_to_product_set_id

string

Beta

The ID of a CatalogProductSet object. If set, the tax is applicable to all products in the product set.