[2025-09-29] Docs updates for the GA of the Copilot Premium requests analytics page (#57704)
Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: amrithss <89491847+amrithss@users.noreply.github.com>
This commit is contained in:
Felicity Chapman
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
assets/images/help/billing/premium-request-analytics-chart.png
Normal file
BIN
assets/images/help/billing/premium-request-analytics-chart.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 187 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 79 KiB |
BIN
assets/images/help/copilot/track-spending-prs.png
Normal file
BIN
assets/images/help/copilot/track-spending-prs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 187 KiB |
@@ -76,7 +76,7 @@ The options available to you vary according to your role and {% data variables.p
|
||||
|
||||
## Exploring usage data in more detail
|
||||
|
||||
You can also explore usage data in more detail in the **{% octicon "graph" aria-label="chart" aria-hidden="true" %} Usage** view.
|
||||
You can also explore usage data for all metered products in more detail in the **Usage** or **Metered usage** view.
|
||||
|
||||
* **Filter data on the page**: click in the text box to see a list of available filters.
|
||||
* **Group data**: options in the "Group" option vary based on the filters you define.
|
||||
@@ -91,22 +91,45 @@ The metered usage chart and usage break down table both show your current choice
|
||||
> For GitHub Actions, you can also view the billable job execution minutes for an individual workflow run. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time).
|
||||
{% endif %}
|
||||
|
||||
## Analyzing use of premium requests
|
||||
|
||||
{% data reusables.billing.premium-request-analytics-start %}
|
||||
|
||||
If you use premium requests, an additional **Premium request analytics** view is listed under **Usage**. You can use this view to dig deeper into how you are using included requests and where you are being billed for additional requests. For example:
|
||||
|
||||
* What's our total usage of premiums requests across all products?
|
||||
* Are users making good use of the premium requests included in their license for {% data variables.product.prodname_copilot_short %}?
|
||||
* Which users have consumed more than their monthly quota?
|
||||
* How widespread is adoption in the organizations where we rolled out {% data variables.product.prodname_copilot_short %}?
|
||||
|
||||
As you change the filter, "Timeframe", and "Group by", and options, all areas of the page are updated to reflect your choices. The chart shows the top 5 consumers and combines any other consumers into "All other".
|
||||
|
||||
|
||||
|
||||
To show more detailed information for the top 100 users or organizations consuming premium requests, use the {% octicon "chevron-right" aria-label="Show Usage Breakdown" aria-hidden="true" %} shown at the start of each row to expand and collapse data.
|
||||
|
||||
|
||||
|
||||
## Downloading usage reports
|
||||
|
||||
You can download two different types of usage report from the "Usage" page.
|
||||
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.
|
||||
|
||||
### General usage reports
|
||||
|
||||
1. At the top of the "Usage" page, click **Get usage report**.
|
||||
1. Choose the report that you want to download.
|
||||
1. At the top of the page, click **Get usage report**.
|
||||
1. If prompted, specify the report details:
|
||||
* Metered usage page: in the dialog displayed, define details of the report that you want to download and click **Email me the report**.
|
||||
* Premium request analytics page: the report will contain usage for the last 45 days.
|
||||
|
||||
For details of the fields included in the report, see [AUTOTITLE](/billing/reference/usage-reports).
|
||||
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.
|
||||
|
||||
### Downloading the data plotted in the usage chart
|
||||
For details of the fields included in the reports, see [AUTOTITLE](/billing/reference/billing-reports).
|
||||
|
||||
When the chart on the "Usage" page shows the data you want to download, click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} "Chart options" button and select your preferred format.
|
||||
### Downloading the data plotted in the chart
|
||||
|
||||
|
||||
When the chart on the "Usage" or "Premium request analytics" page shows the data you want to download, click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} "Chart options" button and select your preferred format.
|
||||
|
||||
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
95
content/billing/reference/billing-reports.md
Normal file
95
content/billing/reference/billing-reports.md
Normal file
@@ -0,0 +1,95 @@
|
||||
---
|
||||
title: Billing reports reference
|
||||
shortTitle: Billing reports
|
||||
intro: 'Billing reports show detailed {% data variables.product.github %} usage, premium request usage, and billing information for your account.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Billing
|
||||
- Enterprise
|
||||
- Team
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}'
|
||||
redirect_from:
|
||||
- /billing/managing-your-billing/about-usage-reports
|
||||
- /billing/reference/usage-reports
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
To generate a usage report, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use).
|
||||
|
||||
## Report types
|
||||
|
||||
There are three different types of reports.
|
||||
|
||||
* Metered usage page:
|
||||
* **Summarized metered usage reports**: A summary of usage for all paid products for a maximum period of one year.
|
||||
* **Detailed metered usage reports**: A detailed usage report for all paid products for a maximum period of 31 days.
|
||||
* Premium request analytics page:
|
||||
* **Premium request analytics usage reports**: A detailed, user-based report on usage of premium requests for the last 45 days.
|
||||
|
||||
### Summarized metered usage reports
|
||||
|
||||
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.
|
||||
|
||||
### Detailed metered usage reports
|
||||
|
||||
The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.
|
||||
|
||||
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`.
|
||||
|
||||
### Premium request analytics usage reports
|
||||
|
||||
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`.
|
||||
|
||||
## Metered usage report fields
|
||||
|
||||
The usage report contains the following fields.
|
||||
|
||||
| Field | Description |
|
||||
|---------------------------|-------------|
|
||||
| `date` | The day that the usage occurred. All usage is logged in UTC. |
|
||||
| `product` | The {% data variables.product.github %} product that was used. |
|
||||
| `sku` | The specific {% data variables.product.github %} product SKU that was used. |
|
||||
| `quantity` | The amount of the SKU that was used. |
|
||||
| `unit_type` | The unit of measurement for the product SKU. |
|
||||
| `applied_cost_per_quantity` | The unit cost of the product SKU. |
|
||||
| `gross_amount` | The amount of the product SKU that was used. |
|
||||
| `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. |
|
||||
| `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`. |
|
||||
| `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
|
||||
| `organization` | The organization associated with the usage, if applicable. |
|
||||
| `repository` | The repository associated with the usage, if applicable. |
|
||||
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
|
||||
| `cost_center_name` | The cost center associated with the usage, if applicable. |
|
||||
|
||||
### Metered usage report fields that are closing down
|
||||
|
||||
{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change.
|
||||
|
||||
| Closing down | Replacement |
|
||||
|--------------------|---------------------|
|
||||
| `usage_at` | Refer to `date` instead. |
|
||||
| `workflow_name` | Refer to `workflow_path` instead. |
|
||||
|
||||
## Premium request analytics usage report fields
|
||||
|
||||
{% data reusables.billing.premium-request-analytics-start %}
|
||||
|
||||
The premium request analytics report contains the following fields.
|
||||
|
||||
| Field | Description |
|
||||
|---------------------------|-------------|
|
||||
| Timestamp | The full UTC date and time in ISO 18601 format. |
|
||||
| User | The {% data variables.product.github %} handle of the user associated with the usage. |
|
||||
| Model | The model used. This might be an LLM like `claude-sonnet-4`, or a product-specific model like `Code Review model`.
|
||||
| Requests Used | The total number of requests used. |
|
||||
| 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 |
|
||||
| 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 %}. |
|
||||
|
||||
## Receiving the report
|
||||
|
||||
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.
|
||||
@@ -11,7 +11,7 @@ topics:
|
||||
children:
|
||||
- /product-usage-included
|
||||
- /actions-minute-multipliers
|
||||
- /usage-reports
|
||||
- /billing-reports
|
||||
- /supported-payment-methods
|
||||
- /azure-subscription
|
||||
- /billing-roles
|
||||
@@ -23,4 +23,3 @@ children:
|
||||
- /enterprise-license-troubleshooting
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
|
||||
@@ -1,72 +0,0 @@
|
||||
---
|
||||
title: Usage reports reference
|
||||
shortTitle: Usage reports
|
||||
intro: 'Usage reports show detailed {% data variables.product.github %} usage and billing information for your account.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Billing
|
||||
- Enterprise
|
||||
- Team
|
||||
permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}'
|
||||
redirect_from:
|
||||
- /billing/managing-your-billing/about-usage-reports
|
||||
contentType: reference
|
||||
---
|
||||
|
||||
The usage report shows detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
|
||||
|
||||
To generate a usage report, see {% ifversion fpt or ghec %}[AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending){% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-billing/gathering-insights-on-your-spending) in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}.
|
||||
|
||||
## Usage report types
|
||||
|
||||
There are two different types of report.
|
||||
|
||||
* Summarized reports can be requested for a maximum time frame of one year.
|
||||
* Detailed reports can be requested for a maximum time frame of 31 days.
|
||||
|
||||
### Summarized report
|
||||
|
||||
The summarized usage 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.
|
||||
|
||||
### Detailed report
|
||||
|
||||
The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.
|
||||
|
||||
The detailed usage 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`.
|
||||
|
||||
## Usage report fields
|
||||
|
||||
The usage report contains the following fields.
|
||||
|
||||
| Field | Description |
|
||||
|---------------------------|-------------|
|
||||
| `date` | The day that the usage occurred. All usage is logged in UTC. |
|
||||
| `product` | The {% data variables.product.github %} product that was used. |
|
||||
| `sku` | The specific {% data variables.product.github %} product SKU that was used. |
|
||||
| `quantity` | The amount of the SKU that was used. |
|
||||
| `unit_type` | The unit of measurement for the product SKU. |
|
||||
| `applied_cost_per_quantity` | The unit cost of the product SKU. |
|
||||
| `gross_amount` | The amount of the product SKU that was used. |
|
||||
| `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. |
|
||||
| `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`. |
|
||||
| `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
|
||||
| `organization` | The organization associated with the usage, if applicable. |
|
||||
| `repository` | The repository associated with the usage, if applicable. |
|
||||
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
|
||||
| `cost_center_name` | The cost center associated with the usage, if applicable. |
|
||||
|
||||
### Report fields closing down
|
||||
|
||||
{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change.
|
||||
|
||||
| Closing down | Replacement |
|
||||
|--------------------|---------------------|
|
||||
| `usage_at` | Refer to `date` instead. |
|
||||
| `workflow_name` | Refer to `workflow_path` instead. |
|
||||
|
||||
## Receiving the report
|
||||
|
||||
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.
|
||||
@@ -16,40 +16,70 @@ product: '{% data reusables.billing.enhanced-billing-platform-product %}'
|
||||
contentType: tutorials
|
||||
---
|
||||
|
||||
You can automatically pull data from {% data variables.product.github %} to populate the business systems you use to monitor costs and usage using the REST API. If you haven't used the {% data variables.product.github %} REST API before, the following articles are a good starting point, see [AUTOTITLE](/rest/using-the-rest-api).
|
||||
You can automatically pull data from {% data variables.product.github %} to populate the business systems you use to monitor costs and usage using the REST API. If you haven't used the {% data variables.product.github %} REST API before, see [AUTOTITLE](/rest/using-the-rest-api).
|
||||
|
||||
## Using the billing platform `/usage` endpoint to retrieve metered usage details for an enterprise or organization
|
||||
## Overview of endpoints
|
||||
|
||||
The new billing platform provides REST API `/usage` endpoints that you can use to report on the use of all metered products in an enterprise or an organization. The usage data provided by the enterprise endpoint is available to enterprise owners and enterprise billing managers, and the data provided by the organization endpoint is available to organization owners within an enterprise and organization owners within an organization account. You will need to authenticate with {% data variables.product.github %}.
|
||||
You need to use different endpoints to gather data depending on your account type and the information level you want.
|
||||
|
||||
* If you use the GitHub CLI, use the `gh auth login` command to authenticate.
|
||||
* Otherwise, you will need to create a {% data variables.product.pat_v1 %}, see [Creating a {% data variables.product.pat_v1 %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
|
||||
{% rowheaders %}
|
||||
|
||||
When you call a `/usage` endpoint, you must specify the enterprise or organization that you want data for and, by default, usage for the current year that does not belong to a cost center is reported. You can reduce the scope of data returned by the endpoint using query parameters.
|
||||
| Account | Report | Access | Endpoint | More information |
|
||||
|---------|--------|--------|----------|------------------|
|
||||
| Users | Usage data for all paid products | Account holder | `/users/{username}/settings/billing/usage` | [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-a-user) |
|
||||
| Organizations | Premium request consumption, with details of quota and billed usage | Organization owners and billing managers | `/organizations/{org}/settings/billing/premium_request/usage` | [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-premium-request-usage-report-for-an-organization) |
|
||||
| Organizations | Usage data for all paid products | Organization owners and billing managers | `/organizations/{org}/settings/billing/usage` | [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-organization) |
|
||||
| Enterprises | Premium request consumption, with details of quota and billed usage | Enterprise owners and billing managers | `/enterprises/{enterprise}/settings/billing/premium_request/usage` | [AUTOTITLE](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-premium-request-usage-report-for-an-enterprise) |
|
||||
| Enterprises | Usage data for all paid products | Enterprise owners and billing managers | `/enterprises/{enterprise}/settings/billing/usage` | [AUTOTITLE](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) |
|
||||
|
||||
* Define a specific time period by setting one or more of the following parameters: `year`, `month`, `day`, and `hour`.
|
||||
* Define a cost center to report on by identifier using the `cost_center_id` query parameter. This query parameter is only available for the enterprise-level endpoint.
|
||||
{% endrowheaders %}
|
||||
|
||||
For more detailed information and an example call and response, see [Get billing usage report for an enterprise](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) or [Get billing usage report for an organization](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-organization) .
|
||||
## Getting premium request consumption
|
||||
|
||||
1. Authenticate with {% data variables.product.github %} with one of the following methods:
|
||||
* **GitHub CLI:** use the `gh auth login` command to authenticate, see [AUTOTITLE](/github-cli/github-cli/quickstart).
|
||||
* **Create a {% data variables.product.pat_v1 %}:** and pass the token to in your API call, see [Creating a {% data variables.product.pat_v1 %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
|
||||
|
||||
1. Call the required `premium_request/usage` endpoint, specifying the enterprise, organization, or user that you want data for.
|
||||
|
||||
To download other metrics for {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/measure-adoption/analyze-usage-over-time).
|
||||
|
||||
## Getting usage data for all paid products
|
||||
|
||||
1. Authenticate with {% data variables.product.github %} with one of the following methods:
|
||||
* **GitHub CLI:** use the `gh auth login` command to authenticate, see [AUTOTITLE](/github-cli/github-cli/quickstart).
|
||||
* **Create a {% data variables.product.pat_v1 %}:** and pass the token to in your API call, see [Creating a {% data variables.product.pat_v1 %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
|
||||
|
||||
1. Call the required `usage` endpoint, specifying the enterprise, organization, or user that you want data for.
|
||||
|
||||
1. By default, data for all products for the current year is reported. For enterprises, only data that is not associated with a cost center is reported.
|
||||
|
||||
You can request more specific data using query parameters.
|
||||
* Specify time period by setting one or more of the following parameters: `year`, `month`, `day`, and `hour`.
|
||||
* Specify a cost center to report on by identifier using the `cost_center_id` query parameter (enterprise endpoint only).
|
||||
|
||||
For more detailed information and an example calls and responses, see:
|
||||
* [Get billing usage report for an enterprise](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise)
|
||||
* [Get billing usage report for an organization](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-organization)
|
||||
* [Get billing usage report for a user](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-a-user)
|
||||
|
||||
<!-- expires 2026-01-15 -->
|
||||
<!-- To check on whether this can be deleted or not, see the PM in ref: 6591 -->
|
||||
|
||||
<!-- expires 2025-12-01 -->
|
||||
## Migrating from the endpoints used for the previous billing platform
|
||||
|
||||
The previous billing platform provided three different endpoints for usage data:
|
||||
After you transition to metered billing, the endpoints you used to get data from the previous billing platform will no longer return accurate usage information.
|
||||
|
||||
* [Get GitHub Actions billing for an enterprise](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-github-actions-billing-for-an-enterprise)
|
||||
* [Get GitHub Packages billing for an enterprise](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-github-packages-billing-for-an-enterprise)
|
||||
* [Get shared storage billing for an enterprise](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-shared-storage-billing-for-an-enterprise)
|
||||
* Upgrade all calls of the form: `/ACCOUNT-TYPE/NAME/settings/billing/PRODUCT`
|
||||
* To use the equivalent: `/ACCOUNT-TYPE/NAME/settings/billing/usage` endpoint
|
||||
|
||||
When you transition to the new billing platform, these endpoints will no longer return accurate usage information. You should upgrade any automation that uses these endpoints to use the new endpoint [GET /enterprises/{enterprise}/settings/billing/usage](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise). The tables below provide a detailed explanation how to use the billing platform to retrieve equivalent information.
|
||||
|
||||
### Changes in call definition
|
||||
### Changes in authentication
|
||||
|
||||
If you used a {% data variables.product.pat_v2 %} to authenticate with the previous endpoints, you will need create a {% data variables.product.pat_v1 %} to authenticate with the new endpoint.
|
||||
|
||||
In addition, you may want to use the new query parameters to specify a time period or cost center.
|
||||
|
||||
### Getting GitHub Actions billing data from the new response data
|
||||
### Calculating {% data variables.product.prodname_actions %} information from the new response data
|
||||
|
||||
Example of the previous response
|
||||
|
||||
@@ -76,7 +106,7 @@ To get the same values from the new response data:
|
||||
|
||||
{% endrowheaders %}
|
||||
|
||||
### Getting GitHub Packages billing data from the new response data
|
||||
### Calculating {% data variables.product.prodname_registry %} information from the new response data
|
||||
|
||||
Example of the previous response
|
||||
|
||||
@@ -100,7 +130,7 @@ Example of the new response
|
||||
|
||||
{% endrowheaders %}
|
||||
|
||||
### Getting shared storage billing from the new response data
|
||||
### Calculating shared storage information from the new response data
|
||||
|
||||
Example of the previous response
|
||||
|
||||
|
||||
@@ -45,6 +45,9 @@ The following {% data variables.product.prodname_copilot_short %} features can u
|
||||
| [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/building-ai-app-prototypes) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. |
|
||||
| [{% data variables.copilot.copilot_cli_short %}](/copilot/concepts/agents/about-copilot-cli) | Each prompt to {% data variables.copilot.copilot_cli_short %} uses **one premium request**. |
|
||||
|
||||
> [!TIP]
|
||||
> For instructions on viewing how many premium requests you have used and advice on how to optimize usage, see [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/monitor-premium-requests).
|
||||
|
||||
## How do request allowances work per plan?
|
||||
|
||||
If you use **{% data variables.copilot.copilot_free_short %}**, your plan comes with up to 2,000 code completion requests and up to 50 premium requests per month. All chat interactions count as premium requests.
|
||||
|
||||
@@ -62,16 +62,22 @@ To create a budget, see [AUTOTITLE](/billing/managing-your-billing/using-budgets
|
||||
|
||||
## Visualizing spending trends
|
||||
|
||||
You can understand your spending trends by viewing a graph for {% data variables.product.prodname_copilot_short %} usage over a certain timeframe. Usage includes costs for {% data variables.product.prodname_copilot_short %} licenses and additional premium requests beyond the allowance.
|
||||
You can understand your spending trends by viewing graphs of {% data variables.product.prodname_copilot_short %} usage over a certain timeframe. Usage includes costs for {% data variables.product.prodname_copilot_short %} licenses and any additional premium requests beyond the allowance.
|
||||
|
||||
For more detailed insights, you can filter the results by cost center and group usage by the type of {% data variables.product.prodname_copilot_short %} plan.
|
||||
For more detailed insights, you can group usage by the type of {% data variables.product.prodname_copilot_short %} plan, and enterprises can filter the results by cost center.
|
||||
|
||||
1. Go to your enterprise or organization account settings and click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**.
|
||||
1. In the left sidebar, click **Usage**.
|
||||
1. In the left sidebar, click **Usage** (organizations) or **Usage** and then **Metered usage** (enterprises).
|
||||
1. In the "Metered usage" section, in the search field, enter `product:copilot`. To filter by cost center, add a query like `cost_center:ce-pilot-group`.
|
||||
1. To understand spending differences between {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans, select the **Group: None** dropdown menu and click **Group: SKU**.
|
||||
1. To understand spending differences between {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans, select the **Group: None** dropdown menu and click **Group by: SKU**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. To visualize the consumption of premium requests in detail, in the left sidebar click **Premium request analytics**.
|
||||
1. By default, the chart and table show use grouped by models. Use the filter, "Group by", and "Timeframe" controls to show the data you want.
|
||||
{% data reusables.billing.premium-request-analytics-start %}
|
||||
|
||||
|
||||
|
||||
## Next steps
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ You can increase the allowance for users by ensuring the policy is enabled, edit
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Before making changes, download a usage report to see which developers are frequently hitting the limit or using a significant number of requests over the allowance. You may want to contact these users to understand their use cases and requirements. See [Downloading a monthly usage report](/copilot/how-tos/monitoring-your-copilot-usage-and-entitlements#downloading-a-monthly-usage-report).
|
||||
* Before making changes, download a usage report to see which developers are frequently hitting the limit or using a significant number of requests over the allowance. You may want to contact these users to understand their use cases and requirements. See [AUTOTITLE](/billing/how-tos/products/view-productlicense-use).
|
||||
* If a user receives licenses from multiple enterprises or standalone organizations, the user must select a billing entity to use premium requests. See [Managing premium request billing with multiple {% data variables.product.prodname_copilot_short %} licenses](/copilot/managing-copilot/monitoring-usage-and-entitlements/monitoring-your-copilot-usage-and-entitlements#managing-premium-request-billing-with-multiple-copilot-licenses).
|
||||
|
||||
## Setting a policy for paid usage
|
||||
|
||||
@@ -28,11 +28,14 @@ You can track your monthly usage of premium requests to help you get the most va
|
||||
There are multiple ways to view your premium request usage:
|
||||
|
||||
* [View current usage directly within your IDE](#viewing-usage-in-your-ide)
|
||||
* [View current usage in your {% data variables.product.prodname_copilot_short %} settings](#viewing-usage-in-your-copilot-settings)
|
||||
* [Download a {% data variables.product.prodname_copilot_short %} premium request usage report](#downloading-a-copilot-premium-request-usage-report)
|
||||
* [View current usage in your {% data variables.product.prodname_copilot_short %} settings](#viewing-an-overview-in-your-copilot-settings)
|
||||
* [View detailed analytics of your usage](#viewing-detailed-analytics-of-your-usage)
|
||||
* [Download a usage report for your personal account](#downloading-a-usage-report-for-your-personal-account)
|
||||
|
||||
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.
|
||||
|
||||
For information about viewing premium request usage for an organization or enterprise, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use).
|
||||
|
||||
### Viewing usage in your IDE
|
||||
|
||||
If you're using {% data variables.product.prodname_copilot_short %} in an editor, you can view your usage directly in the editor. For example, in {% data variables.product.prodname_vscode %}, you can view information about features included in your plan, your progress towards any limits on your plan, and the date your allowance resets.
|
||||
@@ -47,37 +50,33 @@ You can access usage information in the following IDEs.
|
||||
* **In Xcode**, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) in the menu bar.
|
||||
* **In Eclipse**, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) in the status bar at the bottom of Eclipse.
|
||||
|
||||
### Viewing usage in your {% data variables.product.prodname_copilot_short %} settings
|
||||
### Viewing an overview in your {% data variables.product.prodname_copilot_short %} settings
|
||||
|
||||
You can view your premium request usage at any time from your {% data variables.product.prodname_copilot_short %} settings page on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
You can view an overview of your premium request usage at any time from your {% data variables.product.prodname_copilot_short %} "Features" page on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
1. In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile picture.
|
||||
1. Click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} Your {% data variables.product.prodname_copilot_short %}**.
|
||||
1. Under "Usage," view the "Premium requests" progress bar to see the percentage of your premium request quota used for the current month.
|
||||
1. Click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %} settings**.
|
||||
1. On the "Features" page, the "Usage" section displays a "Premium requests" progress bar showing the percentage of your premium request quota used in the current month.
|
||||
|
||||
### Downloading a {% data variables.product.prodname_copilot_short %} premium request usage report
|
||||
### Viewing detailed analytics of your usage
|
||||
|
||||
The premium request usage report includes all premium request usage, both within and beyond the allowance.
|
||||
{% data reusables.user-settings.access_billing_settings_url %}
|
||||
1. In the side bar, click **Premium request analytics** to show detailed analytics.
|
||||
1. Use the filter, "Group by", and "Timeframe" options to change the data displayed in the chart and table.
|
||||
{% data reusables.billing.premium-request-analytics-start %}
|
||||
1. Optionally, to download the data shown in the chart, click the {% octicon "kebab-horizontal" aria-label="Chart options" aria-hidden="true" %} button and select your preferred format.
|
||||
|
||||
>[!NOTE]
|
||||
> For organizations and enterprises, only admins can download a usage report to understand {% data variables.product.prodname_copilot_short %} usage across their business. Individual members of the organization or enterprise cannot download the report for themselves.
|
||||
|
||||
|
||||
1. Navigate to your account.
|
||||
### Downloading a usage report for your personal account
|
||||
|
||||
In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile picture. Then:
|
||||
* For **individual accounts**, click **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings**.
|
||||
* For **organizations**, click **{% octicon "organization" aria-hidden="true" aria-label="organization" %} Your organizations**.
|
||||
* For **enterprises**, click **Your enterprise**, or click **Your enterprises** then click the enterprise you want to view.
|
||||
1. Navigate to your billing settings.
|
||||
* For **individual accounts**, in the "Access" section of the sidebar, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**, then click **Overview**.
|
||||
* For **organizations**, click **{% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings**. Then, in the "Access" section of the sidebar, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**, then click **Usage**.
|
||||
* For **enterprises**, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**, then click **{% octicon "graph" aria-hidden="true" aria-label="graph" %} Usage**.
|
||||
1. Download a CSV usage report.
|
||||
* For **individual accounts**, in the sidebar under "Billing & Licensing," select **Usage**. Then click **Get usage report**, choose the report type and time frame, and click **Email me the report**.
|
||||
* For **organizations**, click the **Get usage report** drop down, then click **{% data variables.product.prodname_copilot_short %} premium requests usage report**.
|
||||
* For **enterprises**, click the **Get usage report** drop down, then click **{% data variables.product.prodname_copilot_short %} premium requests usage report**.
|
||||
Reports include all premium request usage, both within and beyond your allowance.
|
||||
|
||||
The report contains {% data variables.product.prodname_copilot_short %} premium request usage from the past 45 days. Typically the report will be emailed to you within 30 minutes.
|
||||
{% data reusables.user-settings.access_billing_settings_url %}
|
||||
1. In the side bar, click **Premium request analytics** to show detailed analytics.
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
## Optimizing usage of premium requests
|
||||
|
||||
@@ -85,8 +84,6 @@ You can use the following strategies to maximize the value of your premium reque
|
||||
|
||||
* **Choose the right model for the task**. Some models are better suited to different tasks. If you're using a premium request, you can strategically choose which model you use to get the best result from {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/reference/ai-models/model-comparison).
|
||||
|
||||
* **Define whether users can use premium requests over their included allowance**. Set a policy to control whether users can incur extra costs for premium requests when they use up their included allowance. See [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/manage-request-allowances).
|
||||
|
||||
* **Setting a budget**. Set a budget to track your overages and receive alerts when you reach 75%, 90%, or 100% of your budget. See [AUTOTITLE](/billing/managing-your-billing/preventing-overspending#managing-budgets-for-your-personal-account).
|
||||
|
||||
* **Monitor your usage regularly**. Check your usage in your {% data variables.product.github %} account settings to see how many premium requests you’ve used. This helps you plan how much you can use for the rest of the month.
|
||||
@@ -95,6 +92,8 @@ You can use the following strategies to maximize the value of your premium reque
|
||||
|
||||
* **Avoid retrying large prompts unnecessarily**. Submitting the same long or complex prompt multiple times may use more premium requests. Try rephrasing or simplifying your request when needed.
|
||||
|
||||
* **Define whether users can use premium requests over their included allowance** (enterprises and organizations only). Set a policy to control whether users can incur extra costs for premium requests when they use up their included allowance. See [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/manage-request-allowances).
|
||||
|
||||
{% data reusables.copilot.zero-budget-changes-link %}
|
||||
|
||||
## Managing premium request billing with multiple {% data variables.product.prodname_copilot_short %} licenses
|
||||
|
||||
@@ -1 +1 @@
|
||||
The new billing platform is now fully rolled out to all users.
|
||||
The new billing platform is now available to all users.
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
> [!NOTE]
|
||||
> Premium request analytics data are available from August 1, 2025 onward.
|
||||
Reference in New Issue
Block a user