> For the complete documentation index, see [llms.txt](https://docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verifone.com/api-reference/open-api-references/checkout/theming.md).

# Theming

**Themes** control the visual appearance of the hosted checkout page — colours, fonts, logos, and background images. Apply a theme to a checkout session by setting `theme_id` when creating a checkout. You can upload custom images (logos, backgrounds) and reference them in your theme configuration.

{% hint style="info" %}
One theme per account can be set as the default (`is_default: true`). If no `theme_id` is supplied when creating a checkout, the default theme is applied automatically.
{% endhint %}

## How It Works

{% stepper %}
{% step %}

### Upload any images

If your theme requires a custom logo or background, call `POST /v2/image` first to upload the image. The response returns an image URL to reference in the theme.
{% endstep %}

{% step %}

### Create or update the theme

Call `POST /v2/theme` with your branding configuration. Reference uploaded image URLs in the appropriate theme fields. To modify an existing theme, use `PUT /v2/theme/{themeId}`.
{% endstep %}

{% step %}

### Preview before publishing

Use `POST /v2/theme/preview` to generate a preview of how the theme will render on the checkout page, without affecting live sessions.
{% endstep %}

{% step %}

### Apply to a checkout

Pass the `themeId` in the `theme_id` field when calling `POST /v2/checkout`. See [Checkout Sessions](/api-reference/open-api-references/checkout/checkout-sessions.md).
{% endstep %}
{% endstepper %}

## API Reference

## Upload Image

Upload a branding image (logo, background) to reference in theme configurations.

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/image" method="post" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## List Themes

Supports RSQL filtering on `name`, `entity_id`, `is_default`, `created_at`, and `updated_at`.

{% hint style="info" %}
**RSQL filter examples:**

* `name==MyTheme;entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9`
* `is_default==true`

Combine expressions with `;` (AND) or `,` (OR).
{% endhint %}

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme" method="get" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## Create Theme

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme" method="post" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## Preview Theme

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme/preview" method="post" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## Get a Theme by ID

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme/{themeId}" method="get" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## Update Theme

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme/{themeId}" method="put" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## Delete Theme by ID

{% hint style="warning" %}
Deleting a theme is irreversible. Any checkout sessions referencing the deleted theme will fall back to the account default theme.
{% endhint %}

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme/{themeId}" method="delete" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}

## Count Themes

{% openapi src="/files/2a1a4293ec587ee0129ad1caaed6983120845ba1" path="/v2/theme/count" method="get" %}
[a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml](https://content.gitbook.com/content/OiXbo96Og9EN7rz2U44K/blobs/guUKPLHPZbgfg8qR8yIs/a477f48dd9168bd2ee1077c6399dab106e5491bf785fbde57185db0fcb31d32b.yaml)
{% endopenapi %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.verifone.com/api-reference/open-api-references/checkout/theming.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.