Skip to content

Commit e649f04

Browse files
authored
[EDI billing] Create conceptual article about budgets (#57108)
1 parent 00190ad commit e649f04

File tree

4 files changed

+44
-26
lines changed

4 files changed

+44
-26
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Budgets and alerts
3+
intro: 'Budgets help you track and control spending on different products.'
4+
shortTitle: Budgets and alerts
5+
versions:
6+
feature: enhanced-billing-platform
7+
topics:
8+
- Billing
9+
- Enterprise
10+
- Team
11+
contentType: concepts
12+
---
13+
14+
Budgets and alerts allow you to track spending on metered products for your enterprise, organizations, cost centers (enterprise only), and repositories. Budgets and alerts are not available for pre-paid volume licenses.
15+
16+
By setting a monthly budget, you can monitor your spending and receive notifications by email when your spending exceeds certain preset percentages of your budget threshold. This can help you stay within your budget and avoid overspending.
17+
18+
Many accounts already have default budgets for certain products. {% data reusables.billing.migrated-budgets %}
19+
20+
## Stopping usage
21+
22+
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.
23+
24+
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.
25+
26+
## Types and scopes
27+
28+
Each budget has a type and a scope that define which paid use contributes to spending against the budget.
29+
30+
* **Type**: Defines which metered product or SKU is measured.
31+
* **Scope**: Defines whether the budget applies to the whole account, or to a subset of repositories, organizations, or cost centers (enterprise only).
32+
33+
## Your first billing cycle after creating a budget
34+
35+
When you first create a budget, be aware that the budget applies only to metered usage from the date of its creation onwards. Any use made before you created the budget is not included in the calculations. This means that you may exceed your budget in the first billing cycle after you create your budget, even if you select the option stop usage when the limit is reached.
36+
37+
## Set up a budget
38+
39+
To get started with budgets, see [AUTOTITLE](/billing/tutorials/set-up-budgets).

content/billing/concepts/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ topics:
1010
- Billing
1111
children:
1212
- /billing-cycles
13+
- /budgets-and-alerts
1314
- /azure-subscriptions
1415
- /impact-of-plan-changes
1516
- /discounted-plans

content/billing/get-started/how-billing-works.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ topics:
3131
contentType: get-started
3232
---
3333

34-
<!--
34+
<!--
3535
Audience: All users
3636
JTBD: When I decide I want to pay for increased access, I need to understand what and how GitHub will charge me, so that I feel confident that I have been billed correctly and don't get any surprises. -->
3737

@@ -41,7 +41,7 @@ You can use {% data variables.product.github %} without incurring any costs. If
4141

4242
* **{% data variables.product.github %} plans**: A fixed monthly cost for a paid {% data variables.product.github %} account (for example: {% data variables.product.prodname_pro %} or {% data variables.product.prodname_team %}) or {% data variables.product.prodname_copilot_short %} plan.
4343
* **Subscriptions**: Fixed monthly costs for any additional products you subscribe to (for example: {% data variables.product.prodname_GH_secret_protection %})
44-
* **Metered usage**: Variable costs that depend on how much you use certain features above the amounts included with your {% data variables.product.github %} plan (for example: {% data variables.product.prodname_actions %}). For more information see, [AUTOTITLE](/billing/reference/product-usage-included) and [AUTOTITLE](/billing/tutorials/set-up-budgets).
44+
* **Metered usage**: Variable costs that depend on how much you use certain features above the amounts included with your {% data variables.product.github %} plan (for example: {% data variables.product.prodname_actions %}). For more information see, [AUTOTITLE](/billing/reference/product-usage-included) and [AUTOTITLE](/billing/concepts/budgets-and-alerts).
4545

4646
> [!TIP]
4747
> {% data variables.product.github %} has discounted plans for verified students and academic faculties, and for non-profit organizations. For more information, see [AUTOTITLE](/billing/managing-the-plan-for-your-github-account/discounted-plans-for-github-accounts).

content/billing/tutorials/set-up-budgets.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,29 +30,7 @@ shortTitle: Set up budgets
3030
contentType: tutorials
3131
---
3232

33-
Budgets and alerts allow you to track spending on metered products for your accounts, organizations, cost centers (enterprise only), and repositories. By setting a monthly budget, you can monitor your spending and receive notifications by email when your spending exceeds certain preset percentages of your budget threshold. This can help you stay within your budget and avoid overspending.
34-
35-
If your account does not have a valid payment method on file, usage is blocked once you use up your quota.
36-
37-
If you have a valid payment method on file, spending may be limited by one or more budgets. Check the budgets set for your account to ensure they are appropriate for your usage needs.
38-
39-
{% data reusables.billing.migrated-budgets %}
40-
41-
## About budgets
42-
43-
Each budget has a type and a scope that define which paid use contributes to spending against the budget.
44-
45-
* **Type**: Defines which metered product or SKU is measured.
46-
* **Scope**: Defines whether the budget applies to the whole account, or to a subset of repositories, organizations, or cost centers (enterprise only).
47-
48-
### Your first billing cycle after creating a budget
49-
50-
When you first create a budget, be aware that the budget applies only to metered usage from the date of its creation onwards. Any use made before you created the budget, is not included in the calculations. This means that you may exceed your budget in the first billing cycle after you create your budget, even if you select the option stop usage when the limit is reached.
51-
52-
### Budget limitations
53-
54-
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 limit but does provide alerts.
55-
Budgets and alerts are not available for pre-paid volume licenses.
33+
Budgets help you track and control spending on different products. To learn more, see [AUTOTITLE](/billing/concepts/budgets-and-alerts).
5634

5735
## Deciding on the type and scope for a budget
5836

@@ -62,7 +40,7 @@ When deciding on the type and scope for a budget, remember that the use of meter
6240

6341
In this example, the organization has set a budget of $50 for the "Actions" product and a budget of $100 for one of the SKUs within the "Actions" product. The organization has used all the included quota of actions minutes and an extra $50 of billed minutes. Some of the extra use was for Linux 96-core runners so it is applied to both budgets. Overall, the organization has used the full budget for the "Actions" product of $50. Members are now blocked from using all {% data variables.product.github %}-hosted runners until the next billing cycle or until the "Actions" product budget is increased. The SKU budget for Linux 96-core runners serves no purpose and is confusing, so should be deleted.
6442

65-
We recommend that you avoid creating overlapping budgets for the use of a product and a SKU, or an organization and a repository, so that users are not unexpectedly blocked from using a feature that they rely on. Alternative, you may prefer to monitor use without blocking users by disabling the "Stop usage when budget limit is reached" option.
43+
We recommend that you avoid creating overlapping budgets for the use of a product and a SKU, or an organization and a repository, so that users are not unexpectedly blocked from using a feature that they rely on. Alternatively, you may prefer to monitor use without blocking users by disabling the "Stop usage when budget limit is reached" option.
6644

6745
## Managing budgets for your personal account
6846

0 commit comments

Comments
 (0)