Sign in
Sites

Update a site's service charge settings

Use this endpoint to update the service charge settings for a site

put/shop/sites/{siteId}/service-charge-settings

Request body

default_percentagenumber

The percentage service charge to be applied, to the nearest half percent

exit_gratuity_percentagesnumber[]

The percentage options to be presented to customers when exiting through a gate

tip_on_terminal_enabledboolean

Whether to support adding a tip from card reader payments.

tip_on_exit_gate'ask_lead_booker' | 'ask_each_guest' nullable

Whether to support adding a tip when a customer exits through a gate.

allow_exit_voucher_balance_consumptionboolean nullable

Whether exit gratuity should be consumed from gift voucher first.

no_tip_exit_behaviour'allow_exit' | 'disallow_exit' nullable

The behavior to apply when a customer exits through a gate and does not select a tip option for these offerings.

tip_wordingstring nullable

Custom wording to use for the tip option when a customer exits through a gate for these offerings. If not provided, a default wording will be used.

Example request

{
  "default_percentage": 10,
  "exit_gratuity_offering_defaults": [
    {
      "tip_wording": "Add a gratuity for your therapist",
      "offerings": [
        {
          "offering_type": "appointment"
        }
      ]
    }
  ],
  "tip_wording": "Add a gratuity for your therapist",
  "offering_defaults": [
    {
      "percentage": 12.5,
      "offerings": [
        {
          "offering_type": "appointment"
        }
      ]
    }
  ]
}

Response

A response containing a site's service charge settings.

Example response

{
  "data": {
    "default_percentage": 10,
    "exit_gratuity_offering_defaults": [
      {
        "tip_wording": "Add a gratuity for your therapist",
        "offerings": [
          {
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ],
    "offering_defaults": [
      {
        "percentage": 12.5,
        "offerings": [
          {
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ]
      }
    ],
    "tip_wording": "Add a gratuity for your therapist"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.