Retrieve location settingsBeta

GET

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

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

Permissions:MERCHANT_PROFILE_READ

Guide

Checkout Settings

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

location_id

string

Required

The ID of the location for which to retrieve settings.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

location_settings

The location settings.

Link to section

Examples

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

curl https://connect.squareup.com/v2/online-checkout/location-settings/LOCATION_ID_1 \
  -H 'Square-Version: 2024-10-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

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