Skip to content

Commit a4ef495

Browse files
Update usage report docs due to changes in premium request usage report generation (#57882)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
1 parent ad61bd5 commit a4ef495

File tree

3 files changed

+41
-52
lines changed

3 files changed

+41
-52
lines changed

content/billing/how-tos/products/view-productlicense-use.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,11 @@ To show more detailed information for the top 100 users or organizations consumi
112112

113113
## Downloading usage reports
114114

115-
Visit the "Metered Usage" page to access a metered billing report for all products, or navigate to the "Premium request analytics" page for a specialized report tailored for Premium request activity tracking.
116-
117-
### General usage reports
115+
Visit the "Metered Usage" page to access a metered billing report for all products, or navigate to the "Premium request analytics" page for a specialized report tailored for Premium request activity tracking.
118116

119117
1. At the top of the page, click **Get usage report**.
120-
1. If prompted, specify the report details:
121-
* Metered usage page: in the dialog displayed, define details of the report that you want to download and click **Email me the report**.
122-
* Premium request analytics page: the report will contain usage for the last 45 days.
118+
1. Specify the report details.
119+
1. Click **Email me the report**.
123120

124121
When the report is ready for you to download, you'll receive a message to your primary email account with a link to download the report. The link will expire after 24 hours.
125122

content/billing/reference/billing-reports.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,48 @@ redirect_from:
1717
contentType: reference
1818
---
1919

20-
The usage reports show detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
20+
Usage reports show detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
2121

22-
To generate a usage report, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use).
22+
To generate a usage report, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use#downloading-usage-reports).
2323

2424
## Report types
2525

26-
There are three different types of reports.
26+
The following report types are available.
2727

2828
* Metered usage page:
29-
* **Summarized metered usage reports**: A summary of usage for all paid products for a maximum period of one year.
30-
* **Detailed metered usage reports**: A detailed usage report for all paid products for a maximum period of 31 days.
29+
* **Summarized usage report**: A summary of usage for all paid products for a maximum period of one year.
30+
* **Detailed usage report**: A detailed usage report for all paid products for a maximum period of 31 days.
3131
* Premium request analytics page:
32-
* **Premium request analytics usage reports**: A detailed, user-based report on usage of premium requests for the last 45 days.
32+
* **Premium requests usage report**: A detailed per-user breakdown of premium requests consumed for a maximum period of 31 days.
33+
* **Legacy premium request usage report**: A detailed, user-based report of premium request usage for the last 45 days.
3334

34-
### Summarized metered usage reports
35+
### Summarized usage report
3536

3637
This report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `repository`, `cost_center_name`. If the usage report is for an enterprise with organizations, the amounts will be summarized by the organization value as well.
3738

38-
### Detailed metered usage reports
39+
### Detailed usage report
3940

4041
The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.
4142

4243
This report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `organization`, `repository`, `cost_center_name`, `username`, `workflow_path`.
4344

4445
{% data reusables.billing.usage-reports-api-limitation %}
4546

46-
### Premium request analytics usage reports
47+
### Premium requests usage report
4748

48-
This report includes each recorded use of a premium request and includes the following fields: `Timestamp`,`User`,`Model`,`Requests Used`,`Exceeds Monthly Quota`, and `Total Monthly Quota`.
49+
This report includes additional detail about premium request usage. The report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `model`, `username`.
4950

50-
## Metered usage report fields
51+
This report contains usage beginning October 01, 2025 00:00 UTC.
5152

52-
The usage report contains the following fields.
53+
### Legacy premium request usage report
54+
55+
This report includes each recorded use of a premium request and includes the following fields: `Timestamp`,`User`,`Model`,`Requests Used`,`Exceeds Monthly Quota`, and `Total Monthly Quota`. The time period of the report is the most recent 45 days.
56+
57+
This report will be closing down on December 1, 2025, at which point all premium request usage activity will be available via the Premium requests usage report.
58+
59+
## Usage report fields
60+
61+
The usage reports contain the following fields.
5362

5463
| Field | Description |
5564
|---------------------------|-------------|
@@ -61,37 +70,27 @@ The usage report contains the following fields.
6170
| `applied_cost_per_quantity` | The unit cost of the product SKU. |
6271
| `gross_amount` | The amount of the product SKU that was used. |
6372
| `discount_amount` | The amount of usage that was discounted. Usage that is discounted as part of your account’s included usage is reflected in this field. Also includes discounts for {% data variables.product.prodname_actions %} usage for standard {% data variables.product.github %}-hosted runners in public repositories and for self-hosted runners. |
64-
| `net_amount` | The billable amount of usage after applying the `discount_amount`. This is the amount that your account will be billed. `gross_amount - discount_amount = net_amount`. |
65-
| `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
73+
| `net_amount` | The billable amount of usage after applying the `discount_amount`. This is the amount that your account will be billed. `gross_amount - discount_amount = net_amount` |
74+
| `username` | The user associated with the usage, if applicable. <br><br> Not included in the `Summarized usage report`. |
6675
| `organization` | The organization associated with the usage, if applicable. |
6776
| `repository` | The repository associated with the usage, if applicable. |
68-
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
77+
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. <br><br>Only available in the `Detailed usage report` |
6978
| `cost_center_name` | The cost center associated with the usage, if applicable. |
79+
| `model` | The model used. This might be an LLM like `claude-sonnet-4`, or a product-specific model like `Code Review model`. <br><br>Only available in the `Premium request usage report` |
80+
| `exceeds_quota` | Indicates whether the premium request exceeds the user's monthly quota:<br>- `FALSE`: The request is covered by the monthly quota included in the user's plan.<br>- `TRUE`: The request exceeds the monthly quota and will be billed <br><br>Only available in the `Premium request usage report` |
81+
| `total_monthly_quota` | The number of requests included in the user's current plan. {% ifversion fpt or ghec %}See [AUTOTITLE](/copilot/concepts/billing/individual-plans) and [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises).{% endif %} <br><br>Only available in the `Premium request usage report` |
82+
83+
## Receiving the report
84+
85+
Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account. You can only request one usage report per account at a time.
7086

71-
### Metered usage report fields that are closing down
87+
## Metered usage report fields that have closed down
7288

7389
{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change.
7490

75-
| Closing down | Replacement |
91+
The following fields have been removed from the usage reports.
92+
93+
| Field | Replacement |
7694
|--------------------|---------------------|
7795
| `usage_at` | Refer to `date` instead. |
7896
| `workflow_name` | Refer to `workflow_path` instead. |
79-
80-
## Premium request analytics usage report fields
81-
82-
{% data reusables.billing.premium-request-analytics-start %}
83-
84-
The premium request analytics report contains the following fields.
85-
86-
| Field | Description |
87-
|---------------------------|-------------|
88-
| Timestamp | The full UTC date and time in ISO 18601 format. |
89-
| User | The {% data variables.product.github %} handle of the user associated with the usage. |
90-
| Model | The model used. This might be an LLM like `claude-sonnet-4`, or a product-specific model like `Code Review model`.
91-
| Requests Used | The total number of requests used. |
92-
| Exceeds Monthly Quota | This field indicates whether the premium request will be billed separately:<br>- `FALSE`: The request is covered by the monthly quota included in the user's plan.<br>- `TRUE`: The request exceeds the monthly quota and will be billed |
93-
| Total Monthly Quota | This field records the total number of requests included in the user's current plan{% ifversion fpt or ghec %}, see [AUTOTITLE](/copilot/concepts/billing/individual-plans) and [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises){% endif %}. |
94-
95-
## Receiving the report
96-
97-
Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account. You can only request one usage report per account at a time.

content/copilot/how-tos/manage-and-track-spending/monitor-premium-requests.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,8 @@ There are multiple ways to view your premium request usage:
3030
* [View current usage directly within your IDE](#viewing-usage-in-your-ide)
3131
* [Viewing an overview in your Billing and licensing settings](#viewing-an-overview-in-your-billing-and-licensing-settings)
3232
* [View detailed analytics of your usage](#viewing-detailed-analytics-of-your-usage)
33-
* [Download a usage report for your personal account](#downloading-a-usage-report-for-your-personal-account)
3433

35-
If you reach your limit for premium requests, you will be notified with a message in each of the {% data variables.product.prodname_copilot_short %} interfaces you use.
34+
If you reach your limit for premium requests, you will be notified with a message in each of the {% data variables.product.prodname_copilot_short %} interfaces you use. To download a usage report, see [Downloading usage reports](/billing/how-tos/products/view-productlicense-use#downloading-usage-reports).
3635

3736
For information about viewing premium request usage for an organization or enterprise, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use).
3837

@@ -67,15 +66,9 @@ You can view an overview of your premium request usage at any time in your "Bill
6766

6867
![Screenshot of the usage chart on the "Premium request analytics" page with "Chart options" open and outlined in dark orange.](/assets/images/help/billing/premium-request-analytics-chart-download.png)
6968

70-
### Downloading a usage report for your personal account
69+
### Downloading a usage report
7170

72-
Reports include all premium request usage, both within and beyond your allowance.
73-
74-
{% data reusables.user-settings.access_billing_settings_url %}
75-
1. In the side bar, click **Premium request analytics** to show detailed analytics.
76-
1. At the top of the page, click **Get usage report** to generate a CSV report of your premium request use for the past 45 days.
77-
78-
When the report is ready for you to download, you'll receive a message to your primary email account with a link to download the report. The link will expire after 24 hours. For details of the fields included in the reports, see [AUTOTITLE](/billing/reference/billing-reports#premium-request-analytics-usage-report-fields).
71+
For details on how to request a usage report, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use#downloading-usage-reports).
7972

8073
## Optimizing usage of premium requests
8174

0 commit comments

Comments
 (0)