<- Object

Object

V1PaymentSurcharge

V1PaymentSurcharge

Link to section

Properties

Link to section

name

string

The name of the surcharge.

Link to section

applied_money

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

Link to section

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.

Link to section

amount_money

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

Link to section

type

string

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

Link to section

taxable

boolean

Indicates whether the surcharge is taxable.

Link to section

taxes

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

Link to section

surcharge_id

string

A Square-issued unique identifier associated with the surcharge.