gcloud billing budgets update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud billing budgets update - update a budget
- SYNOPSIS
gcloud billing budgets update(BUDGET:--billing-account=BILLING_ACCOUNT)[--credit-types-treatment=CREDIT_TYPES_TREATMENT][--disable-default-iam-recipients][--display-name=DISPLAY_NAME][--filter-credit-types=[FILTER_CREDIT_TYPES,…]][--filter-labels=[KEY=VALUE,…]][--filter-projects=[FILTER_PROJECTS,…]][--filter-resource-ancestors=[FILTER_RESOURCE_ANCESTORS,…]][--filter-services=[FILTER_SERVICES,…]][--filter-subaccounts=[FILTER_SUBACCOUNTS,…]][--notifications-rule-monitoring-notification-channels=[NOTIFICATIONS_RULE_MONITORING_NOTIFICATION_CHANNELS,…]][--notifications-rule-pubsub-topic=NOTIFICATIONS_RULE_PUBSUB_TOPIC][--ownership-scope=OWNERSHIP_SCOPE][--budget-amount=BUDGET_AMOUNT|--last-period-amount][--calendar-period=CALENDAR_PERIOD| [--start-date=START_DATE:--end-date=END_DATE]][--threshold-rules-from-file=PATH_TO_FILE|--add-threshold-rule=[basis=BASIS],[percent=PERCENT]--clear-threshold-rules][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Update a budget.
- EXAMPLES
- To update the amount in the budget called 'abc' in account '123' to '987.65',run:
gcloudbillingbudgetsupdatebillingAccounts/123/budgets/abc--budget-amount=987.65Alternatively, you can run:
gcloudbillingbudgetsupdateabc--billing-account=123--budget-amount=987.65 - POSITIONAL ARGUMENTS
- Budget resource - Billing budget to update. The arguments in this group can beused to specify the attributes of this resource.
This must be specified.
BUDGET- ID of the budget or fully qualified identifier for the budget.
To set the
budgetattribute:- provide the argument
budgeton the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--billing-account=BILLING_ACCOUNT- The billing account.To set the
billing-accountattribute:- provide the argument
budgeton the command line with a fullyspecified name; - provide the argument
--billing-accounton the command line.
- provide the argument
- Budget resource - Billing budget to update. The arguments in this group can beused to specify the attributes of this resource.
- FLAGS
--credit-types-treatment=CREDIT_TYPES_TREATMENT- Whether to include all credit types when calculating the actual spend againstthe budget. If this is not specified, then all credit types are used in thecalculation. If this is set to include-specified-credits, then--filter-credit-types must be specified with a nonempty list of credits.
CREDIT_TYPES_TREATMENTmust be one of:credit-types-treatment-unspecified,exclude-all-credits,include-all-credits,include-specified-credits. --disable-default-iam-recipients- When set to true, disables default notifications sent when a threshold isexceeded. Default notifications are sent to those with Billing AccountAdministrator and Billing Account User IAM roles for the target account.
--display-name=DISPLAY_NAME- User data for display name in UI. Must be less than or equal to 60 characters.
--filter-credit-types=[FILTER_CREDIT_TYPES,…]- Set of credit types, specifying that usage from only this set of credits shouldbe included in the budget. If a nonempty list is specified, then--credit-types-treatment must be include-specified-credits.
--filter-labels=[KEY=VALUE,…]- Single label and value pair specifying that usage from only this set of labeledresources should be included in the budget. Currently, multiple entries ormultiple values per entry are not allowed. If omitted, the report will includeall labeled and unlabeled usage.
--filter-projects=[FILTER_PROJECTS,…]- Set of projects in the form
projects/{project_id}, specifying thatusage from only this set of projects should be included in the budget. Ifomitted, all projects will be included. --filter-resource-ancestors=[FILTER_RESOURCE_ANCESTORS,…]- A set of folder and organization names of the form
folders/{folderId}ororganizations/{organizationId},specifying that usage from only this set of folders and organizations should beincluded in the budget. If omitted, the budget includes all usage that thebilling account pays for. If the folder or organization contains projects thatare paid for by a different Cloud Billing account, the budget doesn't apply tothose projects. --filter-services=[FILTER_SERVICES,…]- Set of services of the form
services/{service_id}, specifying thatusage from only this set of services should be included in the budget. Ifomitted, the report will include usage for all services. The service names areavailable through the Catalog API:https://cloud.google.com/billing/v1/how-tos/catalog-api. --filter-subaccounts=[FILTER_SUBACCOUNTS,…]- Set of subaccounts of the form
billingAccounts/{account_id},specifying that usage from only this set of subaccounts should be included inthe budget. If a subaccount is set to the name of the parent account, usage fromthe parent account will be included. If omitted, the report will include usagefrom the parent account and all subaccounts, if they exist. --notifications-rule-monitoring-notification-channels=[NOTIFICATIONS_RULE_MONITORING_NOTIFICATION_CHANNELS,…]- Targets to send notifications to when a threshold is exceeded. This is inaddition to default recipients who have billing account roles. The value is thefull REST resource name of a monitoring notification channel in the form
projects/{project_id}/notificationChannels/{channel_id}. A maximumof 5 channels is allowed. Seehttps://cloud.google.com/billing/docs/how-to/budgets-notification-recipientsfor more details. --notifications-rule-pubsub-topic=NOTIFICATIONS_RULE_PUBSUB_TOPIC- Name of the Cloud Pub/Sub topic where budget related messages will be published,in the form
projects/{project_id}/topics/{topic_id}. --ownership-scope=OWNERSHIP_SCOPE- Sets the ownership scope of the budget. The ownership scope and users' IAMpermissions determine who has full access to the budget's data.
Must be one of: 'ALL_USERS' or 'BILLING_ACCOUNT'. Use 'ALL_USERS' to allowbilling account- level users and project-level users to have full access to thebudget (if the users have the required IAM permissions). Use 'BILLING_ACCOUNT'to allow only billing account-level users to have full access to the budget.Project-level users will have read-only access, even if they have the requiredIAM permissions.
OWNERSHIP_SCOPEmust be one of:all-users,billing-account,ownership-scope-unspecified. - At most one of these can be specified:
--budget-amount=BUDGET_AMOUNT- Specify the amount of the budget. If a currency type is included, it must be theexisting currency associated with the budget.
--last-period-amount- Use the amount of last period's budget.
- Specify either the calendar-period or custom-period, not both.At most one of these can be specified:
- Calendar Period
--calendar-period=CALENDAR_PERIOD- Specified to track usage over recurring calendar period. If you're creating abudget with a custom time period, omit this flag.
CALENDAR_PERIODmust be one of:calendar-period-unspecified,month,quarter,year.
- Custom Period
--start-date=START_DATE- Specified to track usage after any start date. This time period is static, itdoes not recur.
This flag argument must be specified if any of the other arguments in this groupare specified.
--end-date=END_DATE- Specified to track usage before any end date. This time period is static, itdoes not recur. If specified, --start-date must also be specified.
- Calendar Period
- At most one of these can be specified:
--threshold-rules-from-file=PATH_TO_FILE- Import a file with the updated threshold rules. The threshold rules in the filewill replace the rules in the budget. This can be used to add or remove specificthreshold rules. Use a full or relative path to a local file containing thevalue of threshold_rules.
--add-threshold-rule=[basis=BASIS],[percent=PERCENT]- Rule that triggers alerts (notifications of thresholds being crossed) when spendexceeds the specified percentages of the budget. This flag can be repeated toprovide multiple thresholds above which an alert is sent.
percent- Integer between 0 and 100 above which an alert is sent.
basis- Type of basis used to determine if spend has passed the threshold. Must be oneof: 'current-spend' or 'forecasted-spend'. Behavior defaults to 'current-spend'if not set.
--clear-threshold-rules- Removes all threshold rules from the budget.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - API REFERENCE
- This command uses the
billingbudgets/v1API. The full documentationfor this API can be found at:https://cloud.google.com/billing/docs/how-to/budget-api-overview - NOTES
- These variants are also available:
gcloudalphabillingbudgetsupdategcloudbetabillingbudgetsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.