Object Index / Definition

You are viewing an old version of the API
Order​Service​Charge

Represents a service charge applied to an order

Properties

Name Description
amount_money
Money

The amount of a non-percentage based service charge.

Exactly one of percentage or amount_money should be set.

applied_money
Money

Read only The amount of money applied to the order by the service charge, including any inclusive tax amounts, as calculated by Square.

  • For fixed-amount service charges, applied_money is equal to amount_money.
  • For percentage-based service charges, applied_money is the money calculated using the percentage.
applied_taxes
Order​Line​Item​Applied​Tax [ ]

Beta

The list of references to taxes applied to this service charge. Each OrderLineItemAppliedTax has a tax_uid that references the uid of a top-level OrderLineItemTax that is being applied to this service charge. On reads, the amount applied is populated.

An OrderLineItemAppliedTax will be automatically created on every taxable service charge for all ORDER scoped taxes that are added to the order. OrderLineItemAppliedTax records for LINE_ITEM scoped taxes must be added in requests for the tax to apply to any taxable service charge. Taxable service charges have the taxable field set to true and calculated in the SUBTOTAL_PHASE.

To change the amount of a tax, modify the referenced top-level tax.

calculation_phase
string

The calculation phase at which to apply the service charge.

catalog_object_id
string

The catalog object ID referencing the service charge CatalogObject.

Max Length 192
metadata
object

Beta

Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (personally identifiable information, card details, etc.).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.

Values have a max length of 255 characters.

An application may have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

See Metadata for more information.

name
string

The name of the service charge.

Max Length 255
percentage
string

The service charge percentage as a string representation of a decimal number. For example, "7.25" indicates a service charge of 7.25%.

Exactly 1 of percentage or amount_money should be set.

Max Length 10
taxable
boolean

Indicates whether the service charge can be taxed. If set to true, order-level taxes automatically apply to the service charge. Note that service charges calculated in the TOTAL_PHASE cannot be marked as taxable.

total_money
Money

Read only The total amount of money to collect for the service charge.

Note: if an inclusive tax is applied to the service charge, total_money does not equal applied_money plus total_tax_money since the inclusive tax amount will already be included in both applied_money and total_tax_money.

total_tax_money
Money

Read only The total amount of tax money to collect for the service charge.

uid
string

Beta

Unique ID that identifies the service charge only within this order.

Max Length 60
taxes
Order​Line​Item​Tax [ ]

Deprecated

A list of taxes applied to this service charge. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this service charge. When creating an Order, set your service charge-level taxes in this list. By default, order-level taxes apply to service charges calculated in the SUBTOTAL_PHASE if taxable is set to true.

This field has been deprecated in favour of applied_taxes. Usage of both this field and applied_taxes when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error.

Share Feedback

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