Skip to content
Docs
Get playground access
PUT

Upsert checkout styling for a merchant and one or more countries

https://api.kustom.co/config/checkout/v1/config/checkoutStyling

Parameters2 fields
  • X-merchant-idstringoptionalin header

    Merchant identifier

  • countriesarray<string>optionalin query

    ISO 3166-1 alpha-2 country codes (omit for merchant-level default)

Request body8 fields
  • checkoutStylingobjectoptional

    The checkout styling to configure.

    5 fields in checkoutStyling
    • surfacestringoptional

      Background colour of surfaces, as a 6-digit hex colour.

    • onSurfacestringoptional

      Primary text/content colour shown on surfaces, as a 6-digit hex colour.

    • onSurfaceMutedstringoptional

      Muted/secondary content colour shown on surfaces, as a 6-digit hex colour.

    • primarystringoptional

      Primary brand/action colour, as a 6-digit hex colour.

    • onPrimarystringoptional

      Content colour shown on top of the primary colour, as a 6-digit hex colour.

  • changeReasonstringoptional

    Human-readable reason for the change, stored in the change history.

  • updatedBystringoptional

    Identifier of the user or system making the change.

200
Response11 fields

OK

  • merchantIdstringoptional

    Merchant identifier.

  • countrystringoptional

    ISO 3166-1 alpha-2 country code, or null for the merchant-level default.

  • checkoutStylingobjectoptional

    The configured checkout styling.

    5 fields in checkoutStyling
    • surfacestringoptional

      Background colour of surfaces, as a 6-digit hex colour.

    • onSurfacestringoptional

      Primary text/content colour shown on surfaces, as a 6-digit hex colour.

    • onSurfaceMutedstringoptional

      Muted/secondary content colour shown on surfaces, as a 6-digit hex colour.

    • primarystringoptional

      Primary brand/action colour, as a 6-digit hex colour.

    • onPrimarystringoptional

      Content colour shown on top of the primary colour, as a 6-digit hex colour.

  • revisioninteger · int64optional

    Monotonically increasing revision of this configuration value.

  • updatedBystringoptional

    Identifier of the user or system that last updated the value.

  • updatedAtstring · date-timeoptional

    Timestamp of the last update.

400
Response11 fields

Schema validation failure

  • merchantIdstringoptional

    Merchant identifier.

  • countrystringoptional

    ISO 3166-1 alpha-2 country code, or null for the merchant-level default.

  • checkoutStylingobjectoptional

    The configured checkout styling.

    5 fields in checkoutStyling
    • surfacestringoptional

      Background colour of surfaces, as a 6-digit hex colour.

    • onSurfacestringoptional

      Primary text/content colour shown on surfaces, as a 6-digit hex colour.

    • onSurfaceMutedstringoptional

      Muted/secondary content colour shown on surfaces, as a 6-digit hex colour.

    • primarystringoptional

      Primary brand/action colour, as a 6-digit hex colour.

    • onPrimarystringoptional

      Content colour shown on top of the primary colour, as a 6-digit hex colour.

  • revisioninteger · int64optional

    Monotonically increasing revision of this configuration value.

  • updatedBystringoptional

    Identifier of the user or system that last updated the value.

  • updatedAtstring · date-timeoptional

    Timestamp of the last update.

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.