This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Getting the available service charges

To get the available service charges, send a GET request to the serviceCharges endpoint of the configuration API.

The response provides detailed information about each service charge, including:

guid

The GUID that the Toast platform generated for the service charge.

You use the GUID to add the service charge to a check.

amountType

The amount type for the service charge. amountType is one of the following:

  • PERCENT - The service charge is a specified fixed percentage of the check. For example, the service charge is always 10% of the check.

  • FIXED - The service charge is a specified fixed amount. For example, the service charge is always $5.00.

  • OPEN - The service charge does not have a specified amount. You provide the amount when you add the service charge to the check.

criteria

The eligibility criteria for the service charge. For orders placed using a Toast POS device, the criteria determines when to automatically apply a service charge.

For orders from the orders API, service charges are not added automatically. However, the orders API does use the criteria to validate the added service charges. For example, if you add a delivery service charge to a takeout order, the orders API returns an error.

The criteria includes whether to apply the service charge based on:

  • The dining option. For example, a service charge might only apply to takeout or delivery orders.

  • For delivery orders, the delivery distance.

  • The pre-discount amount of the check. Service charges might apply to orders that are either larger or smaller than a specified amount.