• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update fee
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective November 20th, 2019

Modifies the details of an existing fee (tax).

Required permissions: ITEMS_WRITE

Deprecation date

2019-11-20

Retirement date

2020-11-18

Replaced by

UpsertCatalogObject
Migration guide

Path Parameters

Name Description
location_id
string

Required

The ID of the fee's associated location.

fee_id
string

Required

The ID of the fee to edit.

Request Body

Name Description
id
string

The fee's unique ID.

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

calculation_phase
string

Forthcoming

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.

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.

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.

Response Fields

Name Description
id
string

The fee's unique ID.

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

calculation_phase
string

Forthcoming

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.

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.

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.

Examples

You are viewing an old version of the API
PUT /v1/{location_id}/fees/{fee_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/location_id0/fees/fee_id1 \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?