---
title: ConsentCheckbox
description: Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.
api_version: 2025-10
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/forms/consentcheckbox
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/forms/consentcheckbox.md
---

# Consent​Checkbox

Requires enabling of the `sms_marketing` capability of the [Customer Privacy](https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability group to work.

Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.

## Properties

* accessibilityLabel

  string

  A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.

* checked

  boolean

  Default: false

  Whether the control is active.

* command

  '--auto' | '--show' | '--hide' | '--toggle'

  Default: '--auto'

  Sets the action the `commandFor` should take when this clickable is activated.

  See the documentation of particular components for the actions they support.

  * `--auto`: a default action for the target component.
  * `--show`: shows the target component.
  * `--hide`: hides the target component.
  * `--toggle`: toggles the target component.
  * `--copy`: copies the target ClipboardItem.

* commandFor

  string

  ID of a component that should respond to activations (e.g. clicks) on this component.

  See `command` for how to control the behavior of the target.

* defaultChecked

  boolean

  Default: false

  Whether the control is active by default.

* disabled

  boolean

  Default: false

  Disables the control, disallowing any interaction.

* error

  string

  Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

* id

  string

  A unique identifier for the element.

* label

  string

  Visual content to use as the control label.

* name

  string

  An identifier for the control that is unique within the nearest containing `Form` component.

* policy

  ConsentPolicy

  The policy for which user consent is being collected for.

  `sms-marketing`: Represents the policy for SMS marketing consent.

* value

  string

  The value used in form data when the control is checked.

### ConsentPolicy

```ts
"sms-marketing"
```

## Events

* change

  ((event: CallbackEventListener\<typeof tagName>) => void) | null

  A callback that is run whenever the control is changed.

### CallbackEventListener

```ts
(EventListener & {
    (event: CallbackEvent<TTagName, TEvent>): void;
}) | null
```

### CallbackEvent

```ts
TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}
```

### Examples

* #### Code

  ##### Default

  ```html
  <s-consent-checkbox
    defaultChecked
    label="Text me with news and offers"
    policy="sms-marketing"
  ></s-consent-checkbox>
  ```

## Preview

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