You are viewing an old version of the API

All Versions

Create fee
V1

Deprecated

Note We recommend using the Square API (V2) for all new development when possible.

Creates a fee (tax)

Required permissions ITEMS_WRITE

Path Parameters

Name	Description
`location_id string` Required	The ID of the location to create a fee for.

Name	Description
`id string`	The fee's unique ID.
`adjustment_type string`	The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees.
`applies_to_custom_amounts boolean`	If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item.
`calculation_phase string`	Forthcoming
`enabled boolean`	If true, the fee is applied to all appropriate items. If false, the fee is not applied at all.
`inclusion_type string`	Whether the fee is ADDITIVE or INCLUSIVE.
`name string`	The fee's name.
`rate string`	The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.
`type string`	In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants.
`v2_id string`	The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Name	Description
`id string`	The fee's unique ID.
`adjustment_type string`	The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees.
`applies_to_custom_amounts boolean`	If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item.
`calculation_phase string`	Forthcoming
`enabled boolean`	If true, the fee is applied to all appropriate items. If false, the fee is not applied at all.
`inclusion_type string`	Whether the fee is ADDITIVE or INCLUSIVE.
`name string`	The fee's name.
`rate string`	The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.
`type string`	In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants.
`v2_id string`	The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

curl https://connect.squareup.com/v1/{location_id}/fees \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN'