---
title: Note
description: The API for interacting with the note applied to checkout.
api_version: 2024-10
api_name: customer-account-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/customer-account-ui-extensions/2024-10/apis/order-status-api/note
  md: https://shopify.dev/docs/api/customer-account-ui-extensions/2024-10/apis/order-status-api/note.md
---

# Note

The API for interacting with the note applied to checkout.

## OrderStatusApi

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

* **note**

  **StatefulRemoteSubscribable\<string | undefined>**

  **required**

  A note left by the customer to the merchant, either in their cart or during checkout.

## use​Note()

Returns the proposed `note` applied to the checkout.

### Returns

* **string | undefined**