Skip to content

Commit 3027125

Browse files
mchammer01Copilotsophietheking
authored
Document GHAS SKU-level hard budgets (#61282)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent e922654 commit 3027125

4 files changed

Lines changed: 25 additions & 5 deletions

File tree

content/billing/concepts/budgets-and-alerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ By setting a monthly budget, you can monitor your spending and receive notificat
1515

1616
## Stopping usage
1717

18-
For license-based products such as {% data variables.product.prodname_copilot %}, {% data variables.product.prodname_AS %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_enterprise %}, setting a budget does not prevent usage over the budget amount but does provide alerts.
18+
For most license-based products such as {% data variables.product.prodname_copilot %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_enterprise %}, setting a budget does not prevent usage over the budget amount but does provide alerts. {% data variables.product.prodname_GHAS %} SKUs are an exception to this, as they can be set to stop usage when the budget amount is reached. See [AUTOTITLE](/billing/concepts/product-billing/github-advanced-security#hard-budgets-for-github-advanced-security-skus).
1919

2020
For metered products such as {% data variables.product.prodname_actions %} or {% data variables.product.prodname_copilot %} premium requests, you can choose for budgets to prevent usage once the budget amount is reached.
2121

content/billing/concepts/product-billing/github-advanced-security.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,26 @@ The options available for managing committers and costs depend on your billing m
126126
You can control usage and costs with budgets and alerts. If you use {% data variables.product.prodname_ghe_cloud %}, then you can also use cost centers and policies to control costs.
127127
See {% data reusables.advanced-security.control-use-cost-links %}.
128128

129+
{% ifversion enhanced-billing-platform %}
130+
131+
#### Hard budgets for {% data variables.product.prodname_GHAS %} SKUs
132+
133+
SKU-level budgets for {% data variables.product.prodname_AS %} products ({% data variables.product.prodname_secret_protection %} and {% data variables.product.prodname_code_security %}) support the **Limit usage when budget limit is reached** option. For {% data variables.product.prodname_AS %}, this option prevents new enablement. It does **not** disable {% data variables.product.prodname_AS %} on repositories where it is already active.
134+
135+
When the budget limit is reached:
136+
137+
* Repositories where {% data variables.product.prodname_AS %} is already enabled continue to function normally. Active committers in those repositories are still counted and billed.
138+
* {% data variables.product.prodname_AS %} cannot be enabled on any additional repositories until the budget is increased or a new billing cycle begins.
139+
140+
There are two scenarios where usage may exceed the budget:
141+
142+
* A new committer becomes active in a repository where {% data variables.product.prodname_AS %} is already enabled. You are billed for the additional license cost.
143+
* When you enable {% data variables.product.prodname_AS %} on a repository with more active committers than the remaining budget allows, the enablement succeeds but you are billed for any usage beyond the budget limit.
144+
145+
For more information about budgets, see [AUTOTITLE](/billing/concepts/budgets-and-alerts).
146+
147+
{% endif %}
148+
129149
{% data reusables.billing.actions-usage-delay %}
130150

131151
If your enterprise uses {% data variables.product.prodname_AS %} on both {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}, you can ensure users don't consume multiple licenses unnecessarily by synchronizing license usage between environments. See [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud).

content/billing/how-tos/set-up-budgets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ As the owner of an enterprise or organization account, or as a billing manager,
108108
* To limit spending at a SKU-level, in "SKU-level budget" choose a Product and then a SKU, for example: {% data variables.product.prodname_copilot_short %} and {% data variables.product.prodname_copilot_short %} Premium Request.
109109
To limit spending on premium requests across all features, enable "Bundled premium requests budget" or to limit spending for a specific feature, set a SKU-level budget for the feature (such as {% data variables.product.prodname_copilot_short %} premium requests, {% data variables.product.prodname_spark_short %} premium requests, or {% data variables.copilot.copilot_cloud_agent %} premium requests).
110110
1. Under "Budget scope", set the scope of spending for this budget.
111-
1. Under "Budget", set a budget amount.
111+
1. Under "Budget", set a budget amount or license count.
112112

113-
To stop any usage and further spending once the budget limit is reached, select **Stop usage when budget limit is reached**, if available.
113+
To stop any usage and further spending once the budget limit is reached, select **Stop usage when budget limit is reached** or **Limit usage when budget limit is reached**, if available. **This option is available for metered products and for {% data variables.product.prodname_AS %} SKU-level budgets**. For {% data variables.product.prodname_AS %}, this option prevents new enablement on additional repositories. It doesn't disable {% data variables.product.prodname_AS %} on repositories where it is already active. See [AUTOTITLE](/billing/concepts/product-billing/github-advanced-security#hard-budgets-for-github-advanced-security-skus).
114114

115-
>[!IMPORTANT] If you do not select **Stop usage when budget limit is reached**, you will be notified by email if you exceed your budget, but usage **will not** be stopped.
115+
>[!IMPORTANT] If you do not select one of these options, you will be notified by email if you exceed your budget, but usage **will not** be stopped.
116116
117117
1. To receive an alert if your budget has reached 75%, 90% and 100% thresholds, select **Receive budget threshold alerts** under "Alerts". When the budget has reached the specific threshold, you will be notified via email and a banner on {% data variables.product.github %}. You may opt out at any time.
118118

content/billing/tutorials/control-costs-at-scale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Create one budget for each product, SKU, or group of SKUs that you want to contr
8888
* To limit spending for all premium requests, use the "Bundled premium requests budget".
8989

9090
1. Click **Next: Configure budget** to display "Budget scope" and set the scope of spending for this budget to the cost center you created earlier.
91-
1. Under "Budget", set a budget amount. To stop any usage and further spending once the budget limit is reached, select **Stop usage when budget limit is reached**. This is not available for licensed-based products.
91+
1. Under "Budget", set a budget amount. To stop any usage and further spending once the budget limit is reached, select **Stop usage when budget limit is reached**. This option is available for metered products and for {% data variables.product.prodname_AS %} SKU-level budgets. For more information about how hard budgets work for {% data variables.product.prodname_AS %}, see [AUTOTITLE](/billing/concepts/budgets-and-alerts#hard-budgets-for-github-advanced-security-skus).
9292

9393

9494
1. To receive an alert when usage reaches 75%, 90%, and 100% of the budget target, select **Receive budget threshold alerts** under "Alerts". Account owners, billing managers, and any additional specified recipients will be notified via email. You may opt out at any time.

0 commit comments

Comments
 (0)