CatalogTax Object - Square API Reference

Name	Description
`name string`	The tax's name. Searchable. This field has max length of 255 Unicode code points.
`calculation_phase string`	Whether the tax is calculated based on a payment's subtotal or total.
`inclusion_type string`	Whether the tax is `ADDITIVE` or `INCLUSIVE`.
`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%.
`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`.
`enabled boolean`	If `true`, the tax will be shown as enabled in the Square Point of Sale app.

The tax's name. Searchable. This field has max length of 255 Unicode code points.


        
  
  
          calculation_phase
        


        

        
    string

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


        
  
  
          inclusion_type
        


        

        
    string

Whether the tax is ADDITIVE or INCLUSIVE.


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


        
  
  
          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.

If true, the tax will be shown as enabled in the Square Point of Sale app.

Object Index / Definition

You are viewing an old version of the API

All Versions

CatalogTax