Skip to content

Commit bee3990

Browse files
gmondelloAlenaMarchukam-stead
authored
Update about-usage-reports.md (#56098)
Co-authored-by: AlenaMarchuk <alenamarchuk@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
1 parent e38df08 commit bee3990

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

content/billing/managing-your-billing/about-usage-reports.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,26 @@ permissions: '{% data reusables.permissions.enhanced-billing-platform %}'
1111
product: '{% data reusables.billing.enhanced-billing-platform-product %}'
1212
---
1313

14-
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.
14+
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.
1515

1616
To generate a usage report, see [AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending).
1717

18+
## Usage report types
19+
20+
### Summarized report
21+
22+
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.
23+
24+
Summarized reports can be requested for a maximum time frame of one year.
25+
26+
### Detailed report
27+
28+
The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.
29+
30+
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`.
31+
32+
Detailed reports can be requested for a maximum time frame of 31 days.
33+
1834
## Usage report fields
1935

2036
The usage report contains the following fields.
@@ -30,10 +46,10 @@ The usage report contains the following fields.
3046
| `gross_amount` | The amount of the product SKU that was used. |
3147
| `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. |
3248
| `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`. |
33-
| `username` | The user associated with the usage, if applicable. |
49+
| `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
3450
| `organization` | The organization associated with the usage, if applicable. |
3551
| `repository` | The repository associated with the usage, if applicable. |
36-
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. |
52+
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
3753
| `cost_center_name` | The cost center associated with the usage, if applicable. |
3854

3955
### Deprecated report fields
@@ -45,10 +61,6 @@ The usage report contains the following fields.
4561
| `usage_at` | Refer to `date` instead. |
4662
| `workflow_name` | Refer to `workflow_path` instead. |
4763

48-
## How usage is summarized
49-
50-
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`.
51-
5264
## Receiving the report
5365

5466
Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account.

0 commit comments

Comments
 (0)