## Create

`v1.alerts.create(**kwargs) -> AlertCreateResponse`

**post** `/v1/alerts/create`

Create a new alert

### Parameters

- **alert\_type:** `:low_credit_balance_reached | :spend_threshold_reached | :monthly_invoice_total_spend_threshold_reached | 11 more`

  Type of the alert

  - `:low_credit_balance_reached`

  - `:spend_threshold_reached`

  - `:monthly_invoice_total_spend_threshold_reached`

  - `:low_remaining_days_in_plan_reached`

  - `:low_remaining_credit_percentage_reached`

  - `:usage_threshold_reached`

  - `:low_remaining_days_for_commit_segment_reached`

  - `:low_remaining_commit_balance_reached`

  - `:low_remaining_commit_percentage_reached`

  - `:low_remaining_days_for_contract_credit_segment_reached`

  - `:low_remaining_contract_credit_balance_reached`

  - `:low_remaining_contract_credit_percentage_reached`

  - `:low_remaining_contract_credit_and_commit_balance_reached`

  - `:invoice_total_reached`

- **name:** `String`

  Name of the alert

- **threshold:** `Float`

  Threshold value of the alert policy.  Depending upon the alert type, this number may represent a financial amount, the days remaining, or a percentage reached.

- **billable\_metric\_id:** `String`

  For alerts of type `usage_threshold_reached`, specifies which billable metric to track the usage for.

- **credit\_grant\_type\_filters:** `Array[String]`

  An array of strings, representing a way to filter the credit grant this alert applies to, by looking at the credit_grant_type field on the credit grant. This field is only defined for CreditPercentage and CreditBalance alerts

- **credit\_type\_id:** `String`

  ID of the credit's currency, defaults to USD. If the specific alert type requires a pricing unit/currency, find the ID in the [Metronome app](https://app.metronome.com/offering/pricing-units).

- **custom\_field\_filters:** `Array[{ entity, key, value}]`

  A list of custom field filters for alert types that support advanced filtering. Only present for contract invoices.

  - **entity:** `:Contract | :Commit | :ContractCredit`

    - `:Contract`

    - `:Commit`

    - `:ContractCredit`

  - **key:** `String`

  - **value:** `String`

- **customer\_id:** `String`

  If provided, will create this alert for this specific customer. To create an alert for all customers, do not specify a `customer_id`.

- **evaluate\_on\_create:** `bool`

  If true, the alert will evaluate immediately on customers that already meet the alert threshold. If false, it will only evaluate on future customers that trigger the alert threshold. Defaults to true.

- **group\_values:** `Array[{ key, value}]`

  Only present for `spend_threshold_reached` alerts. Scope alert to a specific group key on individual line items.

  - **key:** `String`

  - **value:** `String`

- **invoice\_types\_filter:** `Array[String]`

  Only supported for invoice_total_reached alerts. A list of invoice types to evaluate.

- **plan\_id:** `String`

  If provided, will create this alert for this specific plan. To create an alert for all customers, do not specify a `plan_id`.

- **uniqueness\_key:** `String`

  Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.

### Returns

- `class AlertCreateResponse`

  - **data:** `ID`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

alert = metronome.v1.alerts.create(
  alert_type: :spend_threshold_reached,
  name: "$100 spend threshold reached",
  threshold: 10000
)

puts(alert)
```