|
1 | 1 | --- |
2 | | -title: 'Downloading licensed use of Advanced Security' |
3 | | -intro: 'You can download consumption of {% data variables.product.prodname_GHAS %} licenses by your {% data variables.enterprise.enterprise_or_org %}: volume/subscription licenses or metered usage.' |
4 | | -permissions: '{% ifversion fpt %}Organization{% else %}Enterprise{% endif %} owners with {% data variables.product.prodname_AS %}' |
5 | | -product: '{% data reusables.gated-features.ghas-billing %}' |
| 2 | +title: 'Downloading license use for your enterprise or organization' |
| 3 | +intro: 'Get data on consumption of {% data variables.product.github %}, {% data variables.product.prodname_copilot_short %}, and {% data variables.product.prodname_AS %} licenses.' |
| 4 | +permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}' |
6 | 5 | versions: |
7 | 6 | fpt: '*' |
8 | | - ghes: '*' |
9 | 7 | ghec: '*' |
| 8 | + ghes: '*' |
10 | 9 | topics: |
11 | 10 | - Billing |
12 | 11 | - Advanced Security |
13 | 12 | - Enterprise |
14 | | -shortTitle: Download GHAS license use |
| 13 | +shortTitle: Download license use |
| 14 | +allowTitleToDifferFromFilename: true |
15 | 15 | redirect_from: |
16 | 16 | - /billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/downloading-your-github-advanced-security-usage |
17 | 17 | contentType: how-tos |
18 | 18 | --- |
19 | 19 |
|
20 | | -## Downloading {% data variables.product.prodname_AS %} license usage information |
21 | | - |
22 | | -You can download a CSV file with details of paid use of {% data variables.product.prodname_GHAS %} products at both the {% data variables.enterprise.enterprise_and_org %} level. The CSV file contains information about each {% data variables.product.prodname_AS %} license that is in use, including: |
23 | | - |
24 | | -* The username of the person using the {% data variables.product.prodname_GHAS_cs_or_sp %} license |
25 | | -* The {% data variables.product.prodname_GH_cs_and_sp %}-enabled repositories where commits were made |
26 | | -* The organizations{% ifversion secret-scanning-user-owned-repos %}{% ifversion ghec %} and user namespaces for {% data variables.product.prodname_emus %}{% endif %}{% endif %} that people using licenses belong to |
27 | | -* The most recent commit dates and associated email addresses |
28 | | - |
29 | | -You can use this information for insights into your paid use of {% data variables.product.prodname_AS %}, such as which members of your enterprise are using a license or how licenses are being consumed across your organizations. |
| 20 | +You can download CSV files with details of paid license use through the {% data variables.product.github %} user interface or the REST API. |
30 | 21 |
|
31 | | -You can download a CSV report of license usage through the {% data variables.product.github %} user interface or the REST API. |
| 22 | +For more detailed reports on usage of all paid products, see [AUTOTITLE](/billing/how-tos/products/view-product-use). |
32 | 23 |
|
33 | | -## Using the UI to download license and metered usage |
| 24 | +## On {% data variables.product.prodname_ghe_cloud %} |
34 | 25 |
|
35 | | -You can download a CSV report for a repository, an organization, or an enterprise. |
| 26 | +1. In the upper-right corner of any page on {% data variables.product.github %}, click your profile picture. |
36 | 27 |
|
37 | | -{% ifversion fpt or ghec %} |
| 28 | +1. Select the account you want to view and then access the "Billing & Licensing" pages: |
38 | 29 |
|
39 | | -### For a repository |
| 30 | + * **Organizations**: Click **Your organizations**, then next to the organization, click **Settings**. In the organization sidebar, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**. |
40 | 31 |
|
41 | | -{% data reusables.profile.access_org %} |
42 | | -{% data reusables.profile.org_settings %} |
43 | | -1. In the "Security" section of the sidebar, select the {% data variables.product.UI_advanced_security %} dropdown menu, then click **{% data variables.product.prodname_global_settings_caps %}**. |
44 | | -1. In the "{% data variables.product.prodname_GH_cs_or_sp %} repositories" section, next to the repository you want usage information for, select {% octicon "kebab-horizontal" aria-label="GHAS repository actions" %}, then click **Download CSV report**. |
| 32 | + * **Enterprises**: Click **Your enterprises**, then click the enterprise name. Click the **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing** tab at the top of the page. |
45 | 33 |
|
46 | | -  |
| 34 | +1. From the list of "Billing & licensing" pages, click {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing** to display the licensing page. |
47 | 35 |
|
48 | | -### For an organization |
| 36 | +1. In the license area of interest, click **Download CSV report**. If offered a choice, choose your preferred report. |
49 | 37 |
|
50 | | -{% data reusables.profile.access_org %} |
51 | | -{% data reusables.profile.org_settings %} |
52 | | -1. In the "Access" section of the sidebar click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing and licensing** to display an overview. |
53 | | -1. For metered usage, in the sidebar click **Usage**. |
54 | | - 1. To display only {% data variables.product.prodname_AS %} usage within the graph, click the search bar, then click **Product**. Within the list of products displayed, click **GHAS**. |
55 | | - 1. To further filter the usage graph, use the dropdown menus: |
56 | | - * To view usage by SKU, select the **Group** dropdown, then click **SKU**. This will allow you to view usage for both {% data variables.product.prodname_GH_cs_and_sp %}. |
57 | | - * To filter by time, select **Time Frame**, then click a time period. |
58 | | - * Below the graph, you can see a more granular overview of the usage. Click the arrow next to a specific date to see a nested table with usage per SKU, units, price/unit, gross amount (the amount actually used), and billed amount (the amount you are charged). |
59 | | - 1. To download the data, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Get usage report**. |
60 | | -1. For license consumption, in the sidebar click **{% octicon "law" aria-hidden="true" aria-label="law" %} Licensing**. |
61 | | - 1. Under "{% data variables.product.prodname_GHAS %}," click the **{% octicon "download" aria-hidden="true" aria-label="download" %} Download CSV report** dropdown and then click either **{% data variables.product.prodname_code_security %}** or **{% data variables.product.prodname_secret_protection %}**. |
| 38 | +The report will be emailed to the default email address associated with your {% data variables.product.github %} account. For information about the fields, see [AUTOTITLE](/billing/reference/license-reports). |
62 | 39 |
|
63 | | -### For an enterprise |
64 | | - |
65 | | -{% data reusables.enterprise-accounts.access-enterprise %} |
66 | | -1. Click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & licensing** to display an overview. |
67 | | -1. For metered usage, click {% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} **Usage**. |
68 | | - 1. To display only {% data variables.product.prodname_AS %} usage within the graph, click the search bar, then click **Product**. Within the list of products displayed, click **GHAS**. |
69 | | - 1. To further filter the usage graph, use the dropdown menus: |
70 | | - * To view usage by SKU, select the **Group** dropdown, then click **SKU**. This will allow you to view usage for both {% data variables.product.prodname_GH_cs_and_sp %}. |
71 | | - * To filter by time, select **Time Frame**, then click a time period. |
72 | | - * Below the graph, you can see a more granular overview of the usage. Click the arrow next to a specific date to see a nested table with usage per SKU, units, price/unit, gross amount (the amount actually used), and billed amount (the amount you are charged). |
73 | | - 1. To download the data, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Get usage report**. |
74 | | -1. For license consumption, click {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing**. |
75 | | - * Under "{% data variables.product.prodname_GHAS %}," click the **{% octicon "download" aria-hidden="true" aria-label="download" %} Download CSV report** dropdown and then click either **{% data variables.product.prodname_code_security %}** or **{% data variables.product.prodname_secret_protection %}**. |
76 | | - |
77 | | -{% elsif ghes %} |
| 40 | +## On {% data variables.product.prodname_ghe_server %} |
78 | 41 |
|
79 | 42 | {% data reusables.enterprise-accounts.access-enterprise %} |
80 | 43 | {% data reusables.enterprise-accounts.license-tab-ghes %} |
81 | | -1. Under "{% data variables.product.prodname_GHAS %}," click **{% octicon "download" aria-hidden="true" aria-label="download" %} CSV report**. |
82 | 44 |
|
83 | | -  |
| 45 | +The page shows a summary of the licenses your enterprise is using for {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_GHAS %}. Use links on the page to view more detailed information. |
84 | 46 |
|
85 | | -{% endif %} |
| 47 | +To download a license usage report for {% data variables.product.prodname_GHAS %}: |
86 | 48 |
|
87 | | -## Using the REST API to download license and metered usage |
| 49 | + * **Enterprise**: In "{% data variables.product.prodname_GHAS %}", click {% octicon "download" aria-hidden="true" aria-label="download" %} **CSV report**. |
| 50 | + * **Organization**: In the "ORGANIZATION" table, click {% octicon "download" aria-label="Download CSV report" %} associated with the organization that you want to download a CSV report for. |
| 51 | + * **User namespace**: In the "USER NAMESPACED" table, click {% octicon "download" aria-label="Download CSV report" %} associated with the user that you want to download a CSV report for. |
| 52 | + * **Repository**: In the "ORGANIZATION" table, click the name of an organization to show a settings page for the organization. In the {% data variables.product.prodname_GHAS %} repositories table, click {% octicon "kebab-horizontal" aria-label="GHAS repository actions" %} and select **Download CSV report**. |
88 | 53 |
|
89 | | -You can retrieve information on paid use of {% data variables.product.prodname_AS %} with the billing API. |
| 54 | +For details of the fields included in the report, see [AUTOTITLE](/billing/reference/license-reports). |
90 | 55 |
|
91 | | -{% ifversion fpt or ghec %} |
| 56 | +## Using the REST API |
92 | 57 |
|
93 | | -For organization-level data, use the `/organizations/{org}/settings/billing/usage` endpoint. For more information, see [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28). |
| 58 | +You can retrieve information on paid use of {% data variables.product.prodname_AS %} with the billing API. |
94 | 59 |
|
95 | | -{% endif %} |
| 60 | +* Organization-level data (cloud only), use the `/organizations/{org}/settings/billing/usage` endpoint.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/rest/billing/enhanced-billing?apiVersion=2022-11-28).{% endif %} |
96 | 61 |
|
97 | | -For enterprise-level data, use the `/enterprises/{enterprise}/settings/billing/usage` endpoint. For more information, see [AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) in the {% data variables.product.prodname_ghe_cloud %} documentation. |
| 62 | +* Enterprise-level data, use the `/enterprises/{enterprise}/settings/billing/usage` endpoint. For more information, see [AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) in the {% data variables.product.prodname_ghe_cloud %} documentation. |
0 commit comments