Get Brand Settings

View as Markdown
Get brand settings for an account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Response

Successful Response
iconstring or nullOptional

GCloud Storage URL for account icon. Treat as the light-on-dark variant — the default used wherever the icon is rendered on a dark background (e.g., the PaymentKit dashboard).

icon_darkstring or nullOptional

GCloud Storage URL for the dark-on-light icon variant — used on light backgrounds where the default icon (light-on-dark) would be invisible. Surfaces fall back to icon if this is unset.

logo_lightstring or nullOptional

GCloud Storage URL for the light-on-dark logo variant — used on dark backgrounds where the default logo (dark-on-light) would be invisible. Surfaces fall back to logo if this is unset.

brand_colorstring or nullOptional
Primary brand color in hex format
accent_colorstring or nullOptional
Accent color in hex format
custom_domainstring or nullOptional
Custom domain for checkout
privacy_policy_urlstring or nullOptional
URL to privacy policy page
terms_of_service_urlstring or nullOptional
URL to terms of service page
statement_descriptor_prefixstring or nullOptional

Statement descriptor prefix (business-name portion of the dynamic statement descriptor). 2-10 Latin chars, >=1 letter, no forbidden chars. Falls back to the account name when unset. Validated in the account controller (the write path is multipart Form).

Errors

422
Unprocessable Entity Error