Skip to main content
GET
Get brand settings

Authorizations

Authorization
string
header
required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

brandId
string
required

The brand's ID - must match the brand your API key identifies (or the Way-Brand-Id header when one is sent).

Query Parameters

include
string

Related resources to include in the response.

Response

200 - application/json

Get brand settings.

brandEmail
string
required

Brand email address.

Example:

"alice@example.com"

paymentPlatform
enum<string>
required

Payment platform used.

Available options:
stripe-us,
stripe-eu,
kicc
Example:

"stripe-us"

templateElement
object
required

Template element settings.

features
object
required

Features settings.

shouldValidateComplimentaryBooking
object
required

Should validate complimentary booking settings.

currency
string
required

Currency code.

Example:

"USD"

wayVersion
enum<string>
required

Way version.

Available options:
V1,
V2,
V3
Example:

"V2"

products
enum<string>[] | null
required

Product lines.

Available options:
activate,
host,
reserve
paymentMethods
object
required

Payment methods.

cancellationPolicyId
string | null
required

Cancellation policy ID.

Example:

"003dbe90-4af0-453d-95f4-d8948ce99999"

isLimited
boolean
required

Whether the brand is a limited (base) partner.

Example:

false

promotion
object

Promotion settings.

customStyle
string

Custom style.

Example:

"#kouto-embed-root [class*=\"BookingConfirmation__LinkBackButton\"] {\ndisplay: none !important;\n}"