Locations
Get Gratuity Configuration
Retrieves the gratuity configuration for a specific location, including if tipping is enabled, allowed gratuity percentages, and the default gratuity percentage.
GET
/
api
/
v1
/
locations
/
{locationId}
/
gratuity
Authorizations
X-API-Key
string
headerrequiredPath Parameters
locationId
string
requiredThe location's unique ID.
Response
200 - application/json
enabled
boolean
Indicates if gratuity is enabled at the location.
shouldAllowCustomTip
boolean
Indicates if customers can enter a custom gratuity amount.
tipPercentage
string[]
An array of allowed gratuity percentages (as strings, e.g., '15', '18', '20').
defaultTipPercentage
string
The default gratuity percentage (as a string, e.g., '18.00').