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

# vantage_budget_alert (Resource)

> Terraform resource reference for vantage_budget_alert (Resource). Auto-generated from the vantage-sh/terraform-provider-vantage repository.

<Note>
  This page is auto-generated based on the official [Terraform documentation](https://registry.terraform.io/providers/vantage-sh/vantage/latest/docs).
</Note>

## Overview

Use this resource with the [Vantage Terraform provider](/terraform). For installation and authentication, see the [Terraform provider quickstart](/terraform#quickstart). The schema below is generated directly from the provider source.

## Example Usage

```terraform theme={null}
resource "vantage_budget_alert" "demo_budget_alert" {
  workspace_token = "wrkspc_47c3254c790e9351"
  budget_tokens   = [vantage_budget.demo_budget.token]
  threshold       = 90

  # Days from the start or end of the month to evaluate. Use "" for the full month.
  duration_in_days = "7"
  period_to_track  = "start_of_the_month"

  # Organization users or addresses on a verified domain.
  recipient_emails = ["finops@example.com"]
}
```

## Schema

### Required

* `budget_tokens` (List of String) The tokens of the Budget that has the alert.
* `duration_in_days` (String) The number of days from the start or end of the month to trigger the alert if the threshold is reached. Use `""` for the full month. This write attribute is a string because the API uses an empty-string sentinel; the `vantage_budget_alerts` data source returns the API's nullable integer response.
* `threshold` (Number) The threshold amount that must be met for the alert to fire.

### Optional

* `period_to_track` (String) The period tracked on the alert. Used with duration\_in\_days to determine the time window of the alert. Defaults to start\_of\_the\_month if not passed. Possible values: start\_of\_the\_month, end\_of\_the\_month.
* `recipient_channels` (List of String) The channels receiving the alerts. Requires an integration provider to be connected. At least one recipient list must resolve to a non-empty value when the alert is created.
* `recipient_emails` (List of String) The complete list of email addresses that receive the alert, including addresses derived from user\_tokens and freeform addresses on verified domains. At least one recipient list must resolve to a non-empty value when the alert is created.
* `user_tokens` (List of String) The tokens of organization users that receive the alert. The API also exposes their addresses in recipient\_emails; freeform verified-domain addresses appear only in recipient\_emails. At least one recipient list must resolve to a non-empty value when the alert is created.
* `workspace_token` (String) The token of the Workspace to add the BudgetAlert to. Required if the API token is associated with multiple Workspaces.

### Read-Only

* `created_at` (String) The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.
* `id` (String) The id of the budget alert
* `integration_provider` (String) The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft\_graph.
* `token` (String) The token of the budget alert
* `user_token` (String) The token for the User who created this BudgetAlert.