Object Index / Definition

You are viewing an old version of the API
Payment​Surcharge
V1

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

V1PaymentSurcharge

Properties

Name Description
amount_money
V1​Money

The amount of the surcharge as a Money object. Exactly one of rate or amount_money should be set.

applied_money
V1​Money

The amount of money applied to the order as a result of the surcharge.

name
string

The name of the surcharge.

rate
string

The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.

surcharge_id
string

A Square-issued unique identifier associated with the surcharge.

taxable
boolean

Indicates whether the surcharge is taxable.

taxes
V1​Payment​Tax [ ]

The list of taxes that should be applied to the surcharge.

type
string

Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group.

Share Feedback

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