---
title: Badge
description: Inform users about the status of an object or indicate that an action has been completed.
api_version: 2025-10
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/titles-and-text/badge
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/titles-and-text/badge.md
---

# Badge

Inform users about the status of an object or indicate that an action has been completed.

## Properties

* color

  'base' | 'subdued'

  Default: 'base'

  Modify the color to be more or less intense.

* icon

  '' | ReducedIconTypes

  Default: ''

  The type of icon to be displayed in the badge.

* iconPosition

  'start' | 'end'

  The position of the icon in relation to the text.

* id

  string

  A unique identifier for the element.

* size

  'small' | 'base' | 'small-100'

  Default: 'base'

  Adjusts the size.

* tone

  'auto' | 'neutral' | 'critical'

  Default: 'auto'

  Sets the tone of the Badge, based on the intention of the information being conveyed.

### ReducedIconTypes

```ts
'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'
```

### Examples

* #### Code

  ##### Default

  ```html
  <s-badge>Default</s-badge>
  <s-badge tone="critical">Expired</s-badge>
  <s-badge color="subdued">Free</s-badge>
  ```

## Preview

![](https://shopify.dev/images/templated-apis-screenshots/checkout-ui-extensions/2025-10/badge-default.png)