CheckoutLocationSettings
Retrieve and update the location-level settings for Square online checkout. Note: A maximum of 2 policy entries is supported in the Policies field.
Table Specific Information
Select
The provider uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the provider.
- LocationId supports the following operator: =.
Retrieve checkout location settings for a specific location:
SELECT * FROM CheckoutLocationSettings WHERE LocationId = '92BYHNBR6W77E'
Update
Modify the checkout location settings by providing the LocationId:
UPDATE CheckoutLocationSettings SET CustomerNotesEnabled = true, BrandingButtonColor = '#000000', BrandingButtonShape = 'ROUNDED', TippingSmartTippingEnabled = true WHERE LocationId = '92BYHNBR6W77E'
Columns
| Name | Type | ReadOnly | Description |
| LocationId [KEY] | String | True |
The ID of the location for these settings. |
| CustomerNotesEnabled | Boolean | False |
Indicates whether customers are allowed to leave notes at checkout. |
| Policies | String | False |
Policy information shown at checkout. An array of policy objects, each with uid, title, and description. |
| BrandingHeaderType | String | False |
The branding header type for the checkout page. The allowed values are BUSINESS_NAME, FRAMED_LOGO, FULL_WIDTH_LOGO. |
| BrandingButtonColor | String | False |
The button color for the checkout page in hexadecimal format (e.g., #FFFFFF). |
| BrandingButtonShape | String | False |
The button shape for the checkout page. The allowed values are SQUARED, ROUNDED, PILL. |
| BrandingLogoUrl | String | True |
The URL of the seller's logo displayed on the online checkout branding page. |
| BrandingFaviconUrl | String | True |
The URL of the seller's favicon displayed on the online checkout branding page. |
| TippingPercentages | String | False |
A list of tip percentages to display on the checkout page. |
| TippingSmartTippingEnabled | Boolean | False |
Indicates whether smart tipping is enabled. |
| TippingDefaultPercent | Integer | False |
The default tipping percentage to display on the checkout page. |
| TippingSmartTips | String | False |
A list of smart tip amounts to display for the checkout page. |
| TippingDefaultSmartTipAmount | Integer | False |
The default smart tip amount to display on the checkout page. |
| TippingDefaultSmartTipCurrency | String | False |
The currency of the default smart tip, in ISO 4217 format. |
| CouponsEnabled | Boolean | False |
Indicates whether coupons are enabled at checkout. |
| UpdatedAt | String | True |
A read-only timestamp in RFC 3339 format indicating when these settings were last updated. |