|
| 1 | +--- |
| 2 | +title: Billing reports reference |
| 3 | +shortTitle: Billing reports |
| 4 | +intro: 'Billing reports show detailed {% data variables.product.github %} usage, premium request usage, and billing information for your account.' |
| 5 | +versions: |
| 6 | + fpt: '*' |
| 7 | + ghec: '*' |
| 8 | + ghes: '*' |
| 9 | +topics: |
| 10 | + - Billing |
| 11 | + - Enterprise |
| 12 | + - Team |
| 13 | +permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}' |
| 14 | +redirect_from: |
| 15 | + - /billing/managing-your-billing/about-usage-reports |
| 16 | + - /billing/reference/usage-reports |
| 17 | +contentType: reference |
| 18 | +--- |
| 19 | + |
| 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. |
| 21 | + |
| 22 | +To generate a usage report, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use). |
| 23 | + |
| 24 | +## Report types |
| 25 | + |
| 26 | +There are three different types of reports. |
| 27 | + |
| 28 | +* 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. |
| 31 | +* 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. |
| 33 | + |
| 34 | +### Summarized metered usage reports |
| 35 | + |
| 36 | +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. |
| 37 | + |
| 38 | +### Detailed metered usage reports |
| 39 | + |
| 40 | +The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`. |
| 41 | + |
| 42 | +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`. |
| 43 | + |
| 44 | +### Premium request analytics usage reports |
| 45 | + |
| 46 | +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`. |
| 47 | + |
| 48 | +## Metered usage report fields |
| 49 | + |
| 50 | +The usage report contains the following fields. |
| 51 | + |
| 52 | +| Field | Description | |
| 53 | +|---------------------------|-------------| |
| 54 | +| `date` | The day that the usage occurred. All usage is logged in UTC. | |
| 55 | +| `product` | The {% data variables.product.github %} product that was used. | |
| 56 | +| `sku` | The specific {% data variables.product.github %} product SKU that was used. | |
| 57 | +| `quantity` | The amount of the SKU that was used. | |
| 58 | +| `unit_type` | The unit of measurement for the product SKU. | |
| 59 | +| `applied_cost_per_quantity` | The unit cost of the product SKU. | |
| 60 | +| `gross_amount` | The amount of the product SKU that was used. | |
| 61 | +| `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. | |
| 62 | +| `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`. | |
| 63 | +| `username` | The user associated with the usage, if applicable. Only available in the detailed report. | |
| 64 | +| `organization` | The organization associated with the usage, if applicable. | |
| 65 | +| `repository` | The repository associated with the usage, if applicable. | |
| 66 | +| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. | |
| 67 | +| `cost_center_name` | The cost center associated with the usage, if applicable. | |
| 68 | + |
| 69 | +### Metered usage report fields that are closing down |
| 70 | + |
| 71 | +{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change. |
| 72 | + |
| 73 | +| Closing down | Replacement | |
| 74 | +|--------------------|---------------------| |
| 75 | +| `usage_at` | Refer to `date` instead. | |
| 76 | +| `workflow_name` | Refer to `workflow_path` instead. | |
| 77 | + |
| 78 | +## Premium request analytics usage report fields |
| 79 | + |
| 80 | +{% data reusables.billing.premium-request-analytics-start %} |
| 81 | + |
| 82 | +The premium request analytics report contains the following fields. |
| 83 | + |
| 84 | +| Field | Description | |
| 85 | +|---------------------------|-------------| |
| 86 | +| Timestamp | The full UTC date and time in ISO 18601 format. | |
| 87 | +| User | The {% data variables.product.github %} handle of the user associated with the usage. | |
| 88 | +| Model | The model used. This might be an LLM like `claude-sonnet-4`, or a product-specific model like `Code Review model`. |
| 89 | +| Requests Used | The total number of requests used. | |
| 90 | +| 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 | |
| 91 | +| 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 %}. | |
| 92 | + |
| 93 | +## Receiving the report |
| 94 | + |
| 95 | +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. |
0 commit comments