jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update about-usage-reports.md (#56098)

Browse Source 
Co-authored-by: AlenaMarchuk <alenamarchuk@github.com>
Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
This commit is contained in:
Greg Mondello
2025-06-23 05:03:27 -05:00
committed by GitHub
parent e38df084df
commit bee399098f
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
content/billing/managing-your-billing/about-usage-reports.md
View File

@@ -11,10 +11,26 @@ permissions: '{% data reusables.permissions.enhanced-billing-platform %}'
product: '{% data reusables.billing.enhanced-billing-platform-product %}' product: '{% data reusables.billing.enhanced-billing-platform-product %}'
--- ---
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. 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 [AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending). To generate a usage report, see [AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending).
## Usage report types
### 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.
Summarized reports can be requested for a maximum time frame of one year.
### 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`.
Detailed reports can be requested for a maximum time frame of 31 days.
## Usage report fields ## Usage report fields
The usage report contains the following fields. The usage report contains the following fields.
@@ -30,10 +46,10 @@ The usage report contains the following fields.
| `gross_amount` | The amount of the product SKU that was used. | | `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. | | `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`. | | `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. | | `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
| `organization` | The organization associated with the usage, if applicable. | | `organization` | The organization associated with the usage, if applicable. |
| `repository` | The repository 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. | | `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. | | `cost_center_name` | The cost center associated with the usage, if applicable. |
### Deprecated report fields ### Deprecated report fields
@@ -45,10 +61,6 @@ The usage report contains the following fields.
| `usage_at` | Refer to `date` instead. | | `usage_at` | Refer to `date` instead. |
| `workflow_name` | Refer to `workflow_path` instead. | | `workflow_name` | Refer to `workflow_path` instead. |
## How usage is summarized
To reduce the size of the report, similar usage entries are grouped and totaled. The report summarizes the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `username`, `workflow_path`, `repository`, `cost_center_name`.
## Receiving the report ## Receiving the report
Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account. Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account.