Create fee
Note We recommend using the Square API (V2) for all new development when possible.
Creates a fee (tax).
Path Parameters
| Name | Description |
|---|---|
location_id
Required
|
The ID of the location to create a fee for. |
Request Body
| Name | Description |
|---|---|
id
|
The fee's unique ID. |
name
|
The fee's name. |
rate
|
The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. |
calculation_phase
|
Forthcoming See V1FeeCalculationPhase for possible values |
adjustment_type
|
The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See V1FeeAdjustmentType for possible values |
applies_to_custom_amounts
|
If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. |
enabled
|
If true, the fee is applied to all appropriate items. If false, the fee is not applied at all. |
inclusion_type
|
Whether the fee is ADDITIVE or INCLUSIVE. See V1FeeInclusionType for possible values |
type
|
In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See V1FeeType for possible values |
v2_id
|
The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. |
Response Fields
| Name | Description |
|---|---|
id
|
The fee's unique ID. |
name
|
The fee's name. |
rate
|
The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. |
calculation_phase
|
Forthcoming See V1FeeCalculationPhase for possible values |
adjustment_type
|
The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See V1FeeAdjustmentType for possible values |
applies_to_custom_amounts
|
If true, the fee applies to custom amounts entered into Square Point of Sale that are not associated with a particular item. |
enabled
|
If true, the fee is applied to all appropriate items. If false, the fee is not applied at all. |
inclusion_type
|
Whether the fee is ADDITIVE or INCLUSIVE. See V1FeeInclusionType for possible values |
type
|
In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See V1FeeType for possible values |
v2_id
|
The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. |
Examples
- cURL
curl https://connect.squareup.com/v1/{location_id}/fees \
-X POST \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'