> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Alert Settings

> Every alert-settings command in the Flexprice CLI, with flags, required fields and examples.

## create

Create alert settings

| Flag                   | Type   | Required | Description                                                                                                                                                                                 |
| ---------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--entity_id`          | string | yes      | entity\_id is the id of the monitored entity: subscription id, subscription\_line\_item id, or group id, matching entity\_type.                                                             |
| `--entity_type`        | string | yes      |                                                                                                                                                                                             |
| `--parent_entity_id`   | string |          | parent\_entity\_id is the subscription id that owns a line-item or group alert. Required when entity\_type is "subscription\_line\_item" or "group"; omitted for subscription-level alerts. |
| `--parent_entity_type` | string |          |                                                                                                                                                                                             |

<Note>
  These fields are nested and cannot be set with flags. Use `--edit` to fill in a pre-built request body, or `--data @file.json`.

  * `config` (object)
</Note>

```sh theme={null}
flexprice alert-settings create --entity_id=<value> --entity_type=<value>
```

## delete

Delete alert settings

```sh theme={null}
flexprice alert-settings delete
```

## list

Query alert settings

| Flag                   | Type    | Required |
| ---------------------- | ------- | -------- |
| `--enabled`            | boolean |          |
| `--end_time`           | string  |          |
| `--entity_id`          | string  |          |
| `--entity_type`        | string  |          |
| `--expand`             | string  |          |
| `--limit`              | integer |          |
| `--offset`             | integer |          |
| `--order`              | string  |          |
| `--parent_entity_id`   | string  |          |
| `--parent_entity_type` | string  |          |
| `--start_time`         | string  |          |
| `--status`             | string  |          |

<Note>
  These fields are nested and cannot be set with flags. Use `--edit` to fill in a pre-built request body, or `--data @file.json`.

  * `entity_ids` (array)
  * `filters` (array)
  * `parent_entity_ids` (array)
  * `sort` (array)
</Note>

```sh theme={null}
flexprice alert-settings list
```

## retrieve

Get alert settings

```sh theme={null}
flexprice alert-settings retrieve
```

## update

Update alert settings

<Note>
  These fields are nested and cannot be set with flags. Use `--edit` to fill in a pre-built request body, or `--data @file.json`.

  * `config` (object)
</Note>

```sh theme={null}
flexprice alert-settings update
```