Object Index / Definition

You are viewing an old version of the API
Fee
V1

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

Deprecated

V1Fee

Properties

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.

Share Feedback

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