v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Checkout

RetrieveLocationSettings

Retrieves the location-level settings for a Square-hosted checkout page.

get/v2/online-checkout/location-settings/{location_id}

Path parameters

location_idstring required

The ID of the location for which to retrieve settings.

Response

Success

Example response

{
  "location_settings": {
    "branding": {
      "button_color": "#ffffff",
      "button_shape": "ROUNDED",
      "header_type": "FRAMED_LOGO"
    },
    "customer_notes_enabled": true,
    "location_id": "LOCATION_ID_1",
    "policies": [
      {
        "description": "This is my Return Policy",
        "title": "Return Policy",
        "uid": "POLICY_ID_1"
      }
    ],
    "tipping": {
      "default_percent": 15,
      "default_whole_amount_money": {
        "amount": 100,
        "currency": "USD"
      },
      "percentages": [
        10,
        15,
        20
      ],
      "smart_tipping_enabled": true,
      "whole_amounts": [
        {
          "amount": 1000,
          "currency": "USD"
        },
        {
          "amount": 1500,
          "currency": "USD"
        },
        {
          "amount": 2000,
          "currency": "USD"
        }
      ]
    },
    "updated_at": "2022-06-16T22:25:35Z"
  }
}