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

Update location settingsBeta

PUT

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

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

Permissions:MERCHANT_PROFILE_WRITE, MERCHANT_PROFILE_READ

Guide

Checkout Settings API

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

Request body

Link to section

location_settings

Required

Describe your updates using the location_settings object. Make sure it contains only the fields that have changed.

Link to section

Response fields

Link to section

errors

Any errors that occurred when updating the location settings.

Link to section

location_settings

The updated location settings.

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

{ "location_settings": { "location_id": "LOCATION_ID_1", "updated_at": "2022-06-16T22:25:35Z", "customer_notes_enabled": false, "policies": [ { "uid": "POLICY_ID_1", "title": "Return Policy", "description": "This is my Return Policy" }, { "uid": "POLICY_ID_2", "title": "Return Policy", "description": "Items may be returned within 30 days of purchase." } ], "branding": { "header_type": "FRAMED_LOGO", "button_color": "#00b23b", "button_shape": "ROUNDED" }, "tipping": { "percentages": [ 15, 20, 25 ], "smart_tipping_enabled": true, "default_percent": 20, "default_whole_amount_money": { "amount": 100, "currency": "USD" }, "whole_amounts": [ { "amount": 1000, "currency": "USD" }, { "amount": 1500, "currency": "USD" }, { "amount": 2000, "currency": "USD" } ] } } }