---
title: "Update overlay checkout style settings"
method: PATCH
path: "/settings/checkout-styles-overlay"
tags: ["Settings"]
---

# Update overlay checkout style settings

`PATCH /settings/checkout-styles-overlay`

## Request

- Base URL: `https://sandbox-api.paddle.com`
- URL: `https://sandbox-api.paddle.com/settings/checkout-styles-overlay`
- Auth: HTTP bearer

Updates the overlay checkout style settings for your account.

Send only the fields that you want to change. Fields that you omit keep their current value. Pass `null` to clear `primary_checkout_color` and use the default checkout color.

If successful, your response includes a copy of the updated overlay checkout style settings entity.

## Request body

- CheckoutStylesOverlayUpdate: Represents the overlay checkout style settings for your account when updating them.
  - `primary_checkout_color` string, nullable: Brand color for overlay checkout, as a six-digit hex code including the leading `#`. Pass `null` to clear the brand color and fall back to the default checkout color.

## Response `200`

The request has succeeded.

- object
  - `data` CheckoutStylesOverlay, required: Represents the overlay checkout style settings for your account.
    - `primary_checkout_color` string, nullable, required: Brand color for overlay checkout, as a six-digit hex code including the leading `#`. `null` when no brand color is set, in which case the default checkout color applies.
  - `meta` Meta, required: Information about this response.
    - `request_id` string, required: Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-10-19** (v1) `4f35a8c6ea4d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paddlehq/apis/paddle-api/changes/settings/checkout-styles-overlay/patch.md)

---

[API](https://skmtc.dev/paddlehq/apis/paddle-api.md) - [All operations](https://skmtc.dev/paddlehq/apis/paddle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paddlehq/apis/paddle-api/revisions/bbc0c72039c8?raw)
