---
title: Toast
description: The API for interacting with toast.
api_version: 2025-10
api_name: customer-account-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/latest/apis/toast
  md: >-
    https://shopify.dev/docs/api/customer-account-ui-extensions/latest/apis/toast.md
---

# Toast

The API for interacting with toast.

## StandardApi

The base API object provided to this and other `customer-account` extension targets.

* toast

  ToastApi

  required

  The Toast API displays a non-disruptive message that displays at the bottom of the interface to provide quick, at-a-glance feedback on the outcome of an action.

  How to use:

  * Use toasts to confirm successful actions.

  * Aim for two words.

  * Use noun + past tense verb format. For example, \`Changes saved\`.

  For errors, or information that needs to persist on the page, use a [banner](https://shopify.dev/docs/api/checkout-ui-extensions/polaris-web-components/feedback/banner) component.

### ToastApi

* show

  ```ts
  (content: string) => Promise<ToastApiResult>
  ```

```ts
export interface ToastApi {
  show: (content: string) => Promise<ToastApiResult>;
}
```

### ToastApiResult

* hide

  ```ts
  () => void
  ```

```ts
export interface ToastApiResult {
  hide: () => void;
}
```