Skip to content

Commit cfbc739

Browse files
gmondelloAndrewRPortersophiethekingShantanuPhadke
authored
Create usage-reports.md (#55958)
Co-authored-by: Andrew Porter <[email protected]> Co-authored-by: Sophie <[email protected]> Co-authored-by: Shantanu Phadke <[email protected]>
1 parent 7ebc887 commit cfbc739

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: About usage reports
3+
intro: 'Learn how to request and understand a report that shows detailed {% data variables.product.github %} usage and billing information for your account.'
4+
versions:
5+
feature: enhanced-billing-platform
6+
type: how_to
7+
topics:
8+
- Enterprise
9+
- Team
10+
permissions: '{% data reusables.permissions.enhanced-billing-platform %}'
11+
product: '{% data reusables.billing.enhanced-billing-platform-product %}'
12+
---
13+
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.
15+
16+
To generate a usage report, see [AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending).
17+
18+
## Usage report fields
19+
20+
The usage report contains the following fields.
21+
22+
| Field | Description |
23+
|---------------------------|-------------|
24+
| `date` | The day that the usage occurred. All usage is logged in UTC. |
25+
| `product` | The {% data variables.product.github %} product that was used. |
26+
| `sku` | The specific {% data variables.product.github %} product SKU that was used. |
27+
| `quantity` | The amount of the SKU that was used. |
28+
| `unit_type` | The unit of measurement for the product SKU. |
29+
| `applied_cost_per_quantity` | The unit cost of the product SKU. |
30+
| `gross_amount` | The amount of the product SKU that was used. |
31+
| `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. |
32+
| `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. |
34+
| `organization` | The organization associated with the usage, if applicable. |
35+
| `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. |
37+
| `cost_center_name` | The cost center associated with the usage, if applicable. |
38+
39+
### Deprecated report fields
40+
41+
{% data variables.product.github %} aims to minimize changes to the usage report structure, however at times the report structure or fields may change.
42+
43+
| Deprecated field | Replacement |
44+
|--------------------|---------------------|
45+
| `usage_at` | Refer to `date` instead. |
46+
| `workflow_name` | Refer to `workflow_path` instead. |
47+
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+
52+
## Receiving the report
53+
54+
Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account.

content/billing/managing-your-billing/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ children:
1919
- /adding-licenses-to-an-organization
2020
- /roles-for-the-new-billing-platform
2121
- /estimating-spending
22+
- /about-usage-reports
2223
- /gathering-insights-on-your-spending
2324
- /charging-business-units
2425
- /preventing-overspending

0 commit comments

Comments
 (0)