New: Checkout and Accounts Configuration API — unified branding for checkout, customer accounts, and sign-in

Changelog
,
1

Hey folks :waving_hand:t4:

Today, we’re thrilled to announce the Checkout And Accounts Configuration API in the 2026-04 GraphQL Admin API. This new API replaces the Checkout Profile API and Checkout Branding API, combining all current and new capabilities into one single API. It offers a cleaner, more intuitive way to manage branding settings across checkout, customer accounts, and sign-in surfaces. At the moment, this API is exclusively available to Shopify Plus merchants.

Why we built this

The Checkout Branding API was built for checkout only. When it expanded to cover customer accounts, inconsistencies crept in—settings that worked on checkout didn’t behave the same way on customer accounts, and visual issues like a white logo that worked well on a dark checkout header started to become invisible on customer accounts’ white header. We built the Checkout And Accounts Configuration API to fix this from the ground up.

What’s new

  1. Shared settings + surface-specific settings: The API introduces a two-layered structure:

    • Shared settings (designTokens and components): typography, corner radius, colors, button styles, and input controls that apply consistently across all surfaces.
    • Surface-specific settings (surfaces.checkout, surfaces.customerAccounts, surfaces.signIn): overrides for logos, background colors, accent colors, and section styles where branding needs to differ.

  2. Direct color settings: Color schemes are replaced by direct color settings. You can directly set any color using HEX values on sections like main, header, and orderSummary, instead of mapping from a limited number of color schemes. You can also use a reusable palette of up to 20 colors to conveniently reference your brand colors in any color setting.

  3. Customize branding per market: The new API supports unique branding configurations per market, so you can tailor checkout and customer account branding for different regions.

More details in developer documentation.

What this means for you

If you’ve used the Checkout Profile API and Checkout Branding API, we recommend that you migrate all implementations to the new Checkout And Accounts Configuration API to enjoy all the benefits it has to offer and access new features as they become available.

The Checkout Profile API and Checkout Branding API are deprecated but remain supported until API version 2027-01 to avoid any disruption during your migration.

I’d love to hear your feedback. Drop your questions or comments below!

1 Like