Shop Settings
Private Shop Settings API endpoints
Partially update the shop's settings: send only the groups and keys you want to change; every other value stays as it is. Lists are replaced whole. The response always holds every key. A request either saves every value it sends or none of them.
Request body
businessoptionalShopSettingsBusinessThe business behind the shop, as customers see it.
localizationoptionalShopSettingsLocalizationWhere and how the shop trades.
gatewaysoptionalShopSettingsGatewaysPayment gateway options.
taxoptionalShopSettingsTaxTax on customer purchases.
storefrontoptionalShopSettingsStorefrontWhat customers can do at checkout and in the customer portal.
brandingoptionalShopSettingsBrandingHow checkout and the customer portal look.
productsoptionalShopSettingsProductsProduct options.
renewalsoptionalShopSettingsRenewalsHow subscriptions renew.
dunningoptionalShopSettingsDunningWhat happens after a renewal payment fails.
analyticsoptionalShopSettingsAnalyticsHow subscription analytics count. They change the numbers only on shops with advanced analytics.
teamoptionalShopSettingsTeamThe shop's team.
trackingoptionalShopSettingsTrackingConversion tracking.
ReturnsShopSettings
Shop settings object response
Error responses
422objectValidation failed: a value has the wrong type or is out of range, null was sent for a key that does not accept it, Stripe rejected business.vat_number, a VAT number was sent for a shop that will not trade in the UK or the EU, localization.trade_country_code changed after a customer placed an order or started a subscription, team two-factor authentication was turned on while a team member has no phone number, or the value needs a feature the shop's Subbly plan doesn't include.