> ## Documentation Index
> Fetch the complete documentation index at: https://docs.way.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get brand settings

> Returns the brand's public configuration: currency, payment platform and methods, enabled features, and styling.



## OpenAPI

````yaml get /v1/brands/{brandId}/settings
openapi: 3.0.0
info:
  title: Way Partner API
  description: >-
    REST API for Way partners: list experiences, check availability, run
    checkout, and manage bookings.
  version: '1.0'
servers:
  - url: https://api.letsway.com
    description: Production.
  - url: https://api.staging.letsway.com
    description: Staging.
security: []
tags:
  - name: Listings
    description: 'Retrieve the listings a brand offers: experiences, events, and resources.'
  - name: Availability
    description: Dates, sessions, and price tiers for scheduling a booking.
  - name: Carts & Checkout
    description: >-
      Payment intents and booking creation. The cart ID is a client-generated
      UUID; there is no create-cart endpoint.
  - name: Bookings
    description: Retrieve, cancel, and reschedule bookings.
  - name: Experiences
    description: Experience details, settings, custom questions, reviews, and hosts.
  - name: Brand Configuration
    description: Brand settings, taxonomy, terms, and promotion code validation.
  - name: Waitlists
    description: Waitlists for sold-out sessions and invitation handling.
  - name: Integrations
    description: Configured integrations, analytics, and room-charge validation.
  - name: Organizations
    description: Organization-level access across brands.
paths:
  /v1/brands/{brandId}/settings:
    get:
      tags:
        - Brand Configuration
      summary: Get brand settings
      description: >-
        Returns the brand's public configuration: currency, payment platform and
        methods, enabled features, and styling.
      operationId: BrandPublicController_getSettings
      parameters:
        - $ref: '#/components/parameters/brandIdPath_56'
        - $ref: '#/components/parameters/includeQuery'
      responses:
        '200':
          description: Get brand settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandSettingsPublicResponseDto'
              example:
                data:
                  name: The Seaside Hotel
                  brandEmail: alice@example.com
                  countryCode: US
                  isLimited: false
                  designElement:
                    logoId: 12a70a52-a8f6-4b4b-8f48-31f45c2f31da
                    logo:
                      id: 12a70a52-a8f6-4b4b-8f48-31f45c2f31da
                      mimeType: image/png
                      uri:
                        original: >-
                          https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                    identityImageId: d594648d-7d27-4179-9e8b-320f7d141670
                    identityImage:
                      id: d594648d-7d27-4179-9e8b-320f7d141670
                      mimeType: image/jpeg
                      uri:
                        original: >-
                          https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                    primaryColor: '#566f77'
                    secondaryColor: '#DEDEDE'
                    buttonColor: '#566f77'
                    primaryFont: inherit
                    secondaryFont: inherit
                    theme: default
                  templateElement:
                    hero:
                      intro: Experiences at The Seaside Hotel
                      heading: Experiences at The Seaside Hotel
                      description: Experiences at The Seaside Hotel.
                      mobileImageId: 1e7ddc63-4cfa-44ab-a1cd-12253751a1a7
                      desktopImageId: f617d393-dd00-4f12-81af-3580c661d56d
                      desktopImage:
                        id: f617d393-dd00-4f12-81af-3580c661d56d
                        mimeType: image/jpeg
                        uri:
                          original: >-
                            https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                      mobileImage:
                        id: 1e7ddc63-4cfa-44ab-a1cd-12253751a1a7
                        mimeType: image/jpeg
                        uri:
                          original: >-
                            https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                      desktopMedia:
                        id: f617d393-dd00-4f12-81af-3580c661d56d
                        type: image
                        kind: cover
                        altText: null
                        links:
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: original
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: '1920'
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: '1080'
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: '1200'
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: '2048'
                      mobileMedia:
                        id: 1e7ddc63-4cfa-44ab-a1cd-12253751a1a7
                        type: image
                        kind: cover
                        altText: null
                        links:
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: original
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: '640'
                          - url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            type: image
                            resolution: '750'
                  features:
                    active:
                      - reviews
                      - exclusiveExperiences
                      - experienceComments
                      - customBookingEmailMessage
                      - smsNotifications
                      - enhancedHostCommission
                      - priceTiers
                      - shoppingCart
                      - customQuestions
                      - enhancedNotifications
                      - emailCustomization
                      - conditionalPricing
                      - unlistedExperience
                      - check-in
                      - inAppMessaging
                      - backendBooking
                      - emailDnsSettings
                      - aiCuration
                      - flexibleDuration
                      - newSessionUi
                      - creditCard
                      - guestMicroSurvey
                      - enableWalletsPayment
                      - integrations:gtmAnalytics
                      - integrations:ga4Analytics
                      - roomMemberCharge
                      - unlimitedHost
                      - experienceListingType
                      - ticketScanning
                      - seatChart
                      - apiAccess
                      - enablePromoter
                      - integrations:revinate
                      - integrations:alice
                      - bypassCTABlock
                      - enableTranslations
                      - integrations:tealiumAnalytics
                      - payUponArrival
                      - enableBookingSurcharge
                      - enableRescheduleBookings
                      - enableHideAddToCartButton
                      - enableNewLandingPage
                      - autoUnpublishListingsWithoutAvailability
                      - enableCompoundTaxCalculation
                    updatedAt: '2025-10-28T15:24:26.512Z'
                    hostsLimit: 999999
                  promotion:
                    exclusiveTag: Members Only
                  customStyle: >-
                    #kouto-embed-root
                    [class*="BookingConfirmation__LinkBackButton"] {

                    display: none !important;

                    }
                  paymentPlatform: stripe-us
                  shouldValidateComplimentaryBooking:
                    roomCharge: false
                    memberCharge: false
                  currency: USD
                  wayVersion: V2
                  products:
                    - host
                    - activate
                    - reserve
                  paymentMethods:
                    alipay: true
                    cashapp: true
                    amazon_pay: true
                    google_pay: true
                    wechat_pay: true
                  cancellationPolicyId: 003dbe90-4af0-453d-95f4-d8948ce99999
                  reschedulePolicyId: null
      security:
        - Brand-API-Key: []
        - Organization-API-Key: []
components:
  parameters:
    brandIdPath_56:
      name: brandId
      in: path
      schema:
        type: string
      required: true
      description: >-
        The brand's ID - must match the brand your API key identifies (or the
        Way-Brand-Id header when one is sent).
    includeQuery:
      name: include
      in: query
      schema:
        type: string
      description: Related resources to include in the response.
      required: false
  schemas:
    BrandSettingsPublicResponseDto:
      type: object
      properties:
        brandEmail:
          type: string
          description: Brand email address.
          example: alice@example.com
        paymentPlatform:
          type: string
          enum:
            - stripe-us
            - stripe-eu
            - kicc
          description: Payment platform used.
          example: stripe-us
        templateElement:
          description: Template element settings.
          allOf:
            - $ref: '#/components/schemas/TemplateElementDto'
        features:
          description: Features settings.
          allOf:
            - $ref: '#/components/schemas/BrandFeaturesDto'
        promotion:
          description: Promotion settings.
          allOf:
            - $ref: '#/components/schemas/PromotionSettingDto'
        customStyle:
          type: string
          description: Custom style.
          example: |-
            #kouto-embed-root [class*="BookingConfirmation__LinkBackButton"] {
            display: none !important;
            }
        shouldValidateComplimentaryBooking:
          description: Should validate complimentary booking settings.
          allOf:
            - $ref: '#/components/schemas/ShouldValidateComplimentaryBooking'
        currency:
          type: string
          description: Currency code.
          example: USD
        wayVersion:
          type: string
          enum:
            - V1
            - V2
            - V3
          description: Way version.
          example: V2
        products:
          type: array
          description: Product lines.
          nullable: true
          items:
            type: string
            enum:
              - activate
              - host
              - reserve
            example: host
        paymentMethods:
          description: Payment methods.
          allOf:
            - $ref: '#/components/schemas/PaymentMethodsSettingDto'
        cancellationPolicyId:
          type: string
          description: Cancellation policy ID.
          nullable: true
          example: 003dbe90-4af0-453d-95f4-d8948ce99999
        isLimited:
          type: boolean
          description: Whether the brand is a limited (base) partner.
          example: false
      required:
        - brandEmail
        - paymentPlatform
        - templateElement
        - features
        - shouldValidateComplimentaryBooking
        - currency
        - wayVersion
        - products
        - paymentMethods
        - cancellationPolicyId
        - isLimited
    TemplateElementDto:
      type: object
      properties:
        hero:
          description: Hero configuration settings.
          allOf:
            - $ref: '#/components/schemas/TemplateElementHeroDto'
      required:
        - hero
    BrandFeaturesDto:
      type: object
      properties:
        features:
          type: object
          description: Feature flags.
          example:
            someFeature: true
    PromotionSettingDto:
      type: object
      properties:
        exclusiveTag:
          type: string
          description: Exclusive tag for promotion.
      required:
        - exclusiveTag
    ShouldValidateComplimentaryBooking:
      type: object
      properties:
        roomCharge:
          type: boolean
          description: Should validate room charge.
        memberCharge:
          type: boolean
          description: Should validate member charge.
      required:
        - roomCharge
        - memberCharge
    PaymentMethodsSettingDto:
      type: object
      properties:
        card:
          type: boolean
          description: Enable card payments.
        apple_pay:
          type: boolean
          description: Enable Apple Pay.
        google_pay:
          type: boolean
          description: Enable Google Pay.
        amazon_pay:
          type: boolean
          description: Enable Amazon Pay.
        cash_app_pay:
          type: boolean
          description: Enable Cash App Pay.
        link:
          type: boolean
          description: Enable Link payment.
        ali_pay:
          type: boolean
          description: Enable Ali Pay.
        wechat_pay:
          type: boolean
          description: Enable WeChat Pay.
    TemplateElementHeroDto:
      type: object
      properties:
        desktopMedia:
          description: Desktop media for the hero section.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/MinimumMediaForResponseDto'
        mobileMedia:
          description: Mobile media for the hero section.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/MinimumMediaForResponseDto'
    MinimumMediaForResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the media.
        original:
          type: string
          description: Original URI of the media.
      required:
        - id
        - original
  securitySchemes:
    Brand-API-Key:
      type: http
      scheme: bearer
      description: >-
        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](/legacy-authentication).
    Organization-API-Key:
      type: http
      scheme: bearer
      description: >-
        Your organization's secret API key, e.g. `Bearer
        way_sk_live_ohEqcn0i1fRoUEHBPjJkQA`. Older `Way-Organization-Id` +
        `Way-Secret-Key` credentials still work: see [Legacy
        authentication](/legacy-authentication).

````