text stringlengths 12 91.7k | metadata dict |
|---|---|
How use of is measured
usage is free for self-hosted runners and for public repositories that use standard -hosted runners. See AUTOTITLE.
For private repositories, each account receives a quota of free minutes, artifact storage, and cache storage for use with -hosted runners, depending on the account's plan. Any us... | {
"source": "github-docs/billing/concepts/product-billing/github-actions.md",
"title": "GitHub Actions billing"
} |
Licenses for
The product has two license SKUs (stock keeping units):
For more information, see feature summary and pricing information and AUTOTITLE.
How usage of licenses is measured
A subset of features are available to all public repositories on free of charge. If you change the visibility of a public reposito... | {
"source": "github-docs/billing/concepts/product-billing/github-advanced-security.md",
"title": "{% data variables.product.prodname_GHAS %} license billing"
} |
How billing is measured
Use of incurs three types of costs for an organization:
minutes
Active and unique committers
minutes
scans run as workflows and consume minutes, unless you use self-hosted runners. See AUTOTITLE.
features that use AI models consume from your shared pool, rather than a separate allo... | {
"source": "github-docs/billing/concepts/product-billing/github-code-quality.md",
"title": "{% data variables.product.prodname_code_quality %} billing"
} |
How use of is measured
A instance (a "codespace") incurs two types of charges.
Compute time: processing time and power, while the codespace is active.
Storage: amount of disk space the codespace or prebuild occupies, while it exists.
In addition, any prebuilt codespaces are generated using actions minutes, see AUTO... | {
"source": "github-docs/billing/concepts/product-billing/github-codespaces.md",
"title": "GitHub Codespaces billing"
} |
usage is measured in —a usage-based billing unit where 1 = .
Individual plans
All individual plans—, , , and —include a monthly allowance that varies by plan.
To understand how work for individual plans, see AUTOTITLE.
Organizations and enterprises
For organizations and enterprises, each assigned license comes wi... | {
"source": "github-docs/billing/concepts/product-billing/github-copilot-billing.md",
"title": "GitHub Copilot billing"
} |
Usage of is measured through a combination of licenses and . See AUTOTITLE and AUTOTITLE.
Licenses for
licenses are required for each user who uses . Licenses are available through different plans depending on your account type.
Account type Options ... | {
"source": "github-docs/billing/concepts/product-billing/github-copilot-licenses.md",
"title": "GitHub Copilot licenses"
} |
How use of is measured
usage is free for public packages. In addition, data transferred in from any source is free.
For private repositories, each account receives a quota of storage and data transfer for use with , depending on the account's plan. Any usage beyond the included amounts is billed to your account.
Da... | {
"source": "github-docs/billing/concepts/product-billing/github-packages.md",
"title": "GitHub Packages billing"
} |
Access using a GITHUBTOKENFreeFree | {
"source": "github-docs/billing/concepts/product-billing/github-packages.md",
"title": "GitHub Packages billing"
} |
Access using a FreePaid
Using more than your included quota
If your account does not have a valid payment method on file, usage is blocked once you use up your quota.
Paying for additional use
You pay for any additional use above your quota using the payment method set up for your account. See AUTOTITLE.
Data trans... | {
"source": "github-docs/billing/concepts/product-billing/github-packages.md",
"title": "GitHub Packages billing"
} |
[!NOTE]
Billing for app creation
Each prompt to consumes based on token usage and the model used. usage is attributed to a dedicated SKU, which allows you to track and set budgets specifically for separately from other features. See AUTOTITLE.
Managing costs
You now have more granular options for managing co... | {
"source": "github-docs/billing/concepts/product-billing/github-spark.md",
"title": "GitHub Spark billing"
} |
includes apps with free and paid pricing plans. After you purchase and install an app, you can upgrade, downgrade, or cancel at any time. This article explains the billing model, that is, what happens when you start, trial, change, or cancel a paid app subscription.
Core billing model
All paid app subscriptions for a... | {
"source": "github-docs/billing/concepts/third-party-payments/github-marketplace-apps.md",
"title": "GitHub Marketplace app subscriptions"
} |
This article describes the billing model for from the sponsor’s point of view.
What a sponsorship billing entry represents
A sponsorship is a monetary commitment you make to a sponsored developer or organization through . Each active recurring sponsorship produces a charge on its renewal date; one‑time sponsorships p... | {
"source": "github-docs/billing/concepts/third-party-payments/github-sponsors.md",
"title": "GitHub Sponsors billing"
} |
<!--
Task: Understand my role and options available in GitHub for controlling costs, so I have enough context to make decisions. --
Introduction to the billing manager role
Organization and enterprise owners can share the work of managing budgets and reporting on costs by inviting members to become billing managers. S... | {
"source": "github-docs/billing/get-started/billing-manager-onboard.md",
"title": "Billing manager onboarding"
} |
<!--
Audience: All users
JTBD: When I decide I want to pay for increased access, I need to understand what and how GitHub will charge me, so that I feel confident that I have been billed correctly and don't get any surprises. --
What charges for
You can use without incurring any costs. If you choose a paid plan, sub... | {
"source": "github-docs/billing/get-started/how-billing-works.md",
"title": "How GitHub billing works"
} |
Key functionalities
The billing and licensing pages on contain views and options to help you understand and manage the cost of using paid products, plans, and subscriptions. Key tasks you can perform are:
Prevent overspending: Use budgets and alerts to track and control your spending.
Observe and understand spending... | {
"source": "github-docs/billing/get-started/introduction-to-billing.md",
"title": "Introduction to billing and licensing"
} |
Prerequisites
Before you start, make sure you know:
username of the client who will become the owner of the enterprise you create
username for the CSP partner that must be assigned to the customer’s enterprise account to manage metered billing and access support
Enterprise name your client would like to use
Email... | {
"source": "github-docs/billing/how-tos/manage-for-client/create-as-csp-partner.md",
"title": "Creating an enterprise account as a Microsoft CSP partner"
} |
Prerequisites
Before you start, make sure you know:
username of the client who will become the owner of the enterprise you create
Enterprise name your client would like to use
Email address for receipts
Number of seats your client needs in the enterprise
Enterprise account type required by your client, see AUTOTI... | {
"source": "github-docs/billing/how-tos/manage-for-client/create-client-enterprise.md",
"title": "Creating and paying for a client's enterprise account"
} |
If you want to create an enterprise account for a client, see AUTOTITLE or AUTOTITLE.
Prerequisites
Before you start, make sure you know:
username of the client who will become the owner of the organization you create
Organization name your client would like to use
Email address for receipts
Number of seats your ... | {
"source": "github-docs/billing/how-tos/manage-for-client/create-client-org.md",
"title": "Creating and paying for an organization for a client"
} |
If you're not already billing manager for the organization, an organization owner at your client will need to add you to the organization as a billing manager. See AUTOTITLE.
Renewing a client's paid plan
If your client's organization already has a valid payment method, the plan will automatically renew at the start o... | {
"source": "github-docs/billing/how-tos/manage-for-client/manage-client-org.md",
"title": "Managing your client's paid organization"
} |
Downgrading your personal account's plan
If you downgrade your personal account from to , the account will lose access to advanced code review tools on private repositories.
1. Under "Current plan", use the Edit drop-down and click Downgrade to Free.
!Screenshot of the "Current plan" section of the billing setting... | {
"source": "github-docs/billing/how-tos/manage-plan-and-licenses/downgrade-plan.md",
"title": "Downgrading your account's plan"
} |
About pending plan changes
You can cancel pending changes to your account's plan as well as pending changes to other subscriptions and usage-based billing.
When you cancel a pending change, your plan will not change until your next billing date.
Viewing and managing pending changes to your personal account's plan
Vie... | {
"source": "github-docs/billing/how-tos/manage-plan-and-licenses/manage-pending-changes.md",
"title": "Viewing and managing pending changes to your plan"
} |
Organizations on
If you're the owner or billing manager of an organization on a plan, you can add or remove user licenses to your plan through the "Licensing" page.
1. In the banner, click Edit and select Add seats or Remove seats.
1. Define the number of new seats you require. The details of the prorated cost for t... | {
"source": "github-docs/billing/how-tos/manage-plan-and-licenses/manage-user-licenses.md",
"title": "Managing user licenses for an organization or enterprise"
} |
Upgrading your personal account's plan
You can upgrade your personal account from to to get advanced code review tools on private repositories owned by your personal account.
Upgrading your personal account does not affect any organizations you may manage or repositories owned by those organizations.
1. In the left ... | {
"source": "github-docs/billing/how-tos/manage-plan-and-licenses/upgrade-plan.md",
"title": "Upgrading your account's plan"
} |
Viewing subscription and usage for your enterprise
You can view the subscription and usage for your enterprise and download a file with license details.
The information displayed varies according to your enterprise set up.
, potentially with licenses synchronized from
To learn more about the license data associated w... | {
"source": "github-docs/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md",
"title": "Viewing usage for your GitHub Enterprise plan"
} |
About license files for
After you purchase or upgrade a license for from , you must download your new license file. For more information about licenses for , see AUTOTITLE.
Downloading your license file
There are two possible ways to download a license file for .
1. If you are using a trial of , if you do not have a... | {
"source": "github-docs/billing/how-tos/manage-server-licenses/download-your-license.md",
"title": "Downloading your license for GitHub Enterprise"
} |
A license allows a user to use both and . See AUTOTITLE.
To view combined license details on and ensure users only consume one license, you must sync licenses between deployments. You can do this:
Automatically, using .
Manually, by uploading a license file from from to .
When you synchronize license usage, only ... | {
"source": "github-docs/billing/how-tos/manage-server-licenses/sync-license-usage.md",
"title": "Syncing license usage from GitHub Enterprise Server to Cloud"
} |
About license files for
When you purchase or download a new license for you must upload the new license file to to unlock your new user licenses.
If you use , you can download a license from your enterprise. For more information, see AUTOTITLE and AUTOTITLE.
Uploading your license from the
1. Sign into as a site ... | {
"source": "github-docs/billing/how-tos/manage-server-licenses/upload-new-license.md",
"title": "Uploading a new license to GitHub Enterprise Server"
} |
When you cancel a paid app, your access and subscription will end on your next billing date. If you cancel during a free trial, you will lose access immediately. For more information, see AUTOTITLE.
Canceling an app for your personal account
Canceling a free trial for an app for your personal account
Canceling an ap... | {
"source": "github-docs/billing/how-tos/pay-third-parties/cancel-marketplace-app.md",
"title": "Canceling a GitHub Marketplace app"
} |
When you cancel a sponsorship, the change will become effective on your next billing date.
Canceling a sponsorship
1. Under "", next to the sponsored account, click your current tier amount, then click Cancel sponsorship.
1. Review the alert about canceling your sponsorship, then click OK.
Canceling a scheduled spon... | {
"source": "github-docs/billing/how-tos/pay-third-parties/cancel-sponsorship.md",
"title": "Canceling a sponsorship"
} |
When you downgrade an app, your subscription remains active until the end of your current billing cycle. The downgrade takes effect on your next billing date. For more information, see AUTOTITLE.
Downgrading an app for your personal account
Downgrading an app for your organization
Downgrading an app in your enterpri... | {
"source": "github-docs/billing/how-tos/pay-third-parties/downgrade-marketplace-app.md",
"title": "Downgrading the billing plan for a GitHub Marketplace app"
} |
When you downgrade a sponsorship, the change will become effective on your next billing date.
Downgrading a sponsorship
For information about canceling a sponsorship, see AUTOTITLE. | {
"source": "github-docs/billing/how-tos/pay-third-parties/downgrade-sponsorship.md",
"title": "Downgrading a sponsorship"
} |
You can set an end date to your sponsorship. The end date assigned will be the last date for which you will be charged for that sponsorship, but the sponsorship will show active for another month.
For example, if July 2025 is set as the end date, the last sponsorship will be charged in July 2025, but the sponsorship wi... | {
"source": "github-docs/billing/how-tos/pay-third-parties/end-sponsorship.md",
"title": "Setting an end date to a sponsorship"
} |
When you upgrade an app, your payment method is charged a prorated amount based on the time remaining until your next billing date. For more information, see AUTOTITLE.
Upgrading an app for your personal account
Upgrading an app for your organization
Upgrading an app in your enterprise | {
"source": "github-docs/billing/how-tos/pay-third-parties/upgrade-marketplace-app.md",
"title": "Upgrading the billing plan for a GitHub Marketplace app"
} |
When you upgrade your sponsorship tier, the change will become effective immediately.
Upgrading a sponsorship | {
"source": "github-docs/billing/how-tos/pay-third-parties/upgrade-sponsorship.md",
"title": "Upgrading a sponsorship"
} |
Checking your current plan
You must use a or plan before you can enable on private repositories.
Your current plan is shown with any options to upgrade to a different plan.
Metered billing users
If your organization or enterprise uses metered billing, then you are ready to start enabling . Whenever you enable a fea... | {
"source": "github-docs/billing/how-tos/products/buy-advanced-security.md",
"title": "Buying Advanced Security for your organization or enterprise"
} |
If you want to immediately disable in all repositories, prevent organizations from re-enabling it and avoid unexpected billing charges, you can use the Disable option available in the enterprise licensing page. This is different from canceling your subscription:
Canceling your subscription stops future billing but ... | {
"source": "github-docs/billing/how-tos/products/disable-ghas-for-enterprise.md",
"title": "Disabling GitHub Advanced Security for your enterprise"
} |
You can download CSV files with details of paid license use through the user interface or the REST API.
For more detailed reports on usage of all paid products, see AUTOTITLE.
On
1. In the license area of interest, click Download CSV report. If offered a choice, choose your preferred report.
The report will be email... | {
"source": "github-docs/billing/how-tos/products/download-license-use.md",
"title": "Downloading license use for your enterprise or organization"
} |
The new billing platform provides a high-level view of your spending trends based on the usage across products. You can use this information to estimate your spending and make informed decisions about your budget.
Viewing spending for your personal account
1. In the "Access" section of the sidebar, click Billing & Li... | {
"source": "github-docs/billing/how-tos/products/estimate-spending.md",
"title": "Viewing and estimating your spending"
} |
There are two different ways to pay for licenses: volume/subscription licenses purchased in advance or usage-based metered billing paid in arrears. This article is about volume/subscription licenses. For information about the two different billing models, see AUTOTITLE.
For information about using policies to control ... | {
"source": "github-docs/billing/how-tos/products/manage-ghas-licenses.md",
"title": "Managing volume licenses for GitHub Advanced Security"
} |
[!NOTE] Before you create or update a cost center, if you're unsure of how spending will be allocated to the cost center, see AUTOTITLE.
Creating a cost center
[!NOTE]
An enterprise can create up to 1,000 cost centers.
Create cost centers to monitor and manage expenses for specific organizations or repositories. A s... | {
"source": "github-docs/billing/how-tos/products/use-cost-centers.md",
"title": "Using cost centers to allocate costs to business units"
} |
About the "Advanced Security Committers" dashboard
You can estimate the number of licenses your enterprise might need for with the "Advanced Security Committers" section of the site admin dashboard.
If you currently use , this tool helps you understand how many committers are currently using licenses. It also helps yo... | {
"source": "github-docs/billing/how-tos/products/view-ghas-committers.md",
"title": "Viewing committer information for Advanced Security licenses"
} |
[!TIP]
administrators should instead see AUTOTITLE.
Viewing a summary of usage
The options available to you vary according to your role and plan.
:
Anyone can view usage data for their own personal account unless a license for a metered product (for example, ) is assigned to them by an organization or enterprise a... | {
"source": "github-docs/billing/how-tos/products/view-productlicense-use.md",
"title": "Viewing your usage of metered products and licenses"
} |
Budgets help you track and control spending on different products. To learn more, see AUTOTITLE.
Plan your budget type and scope
Before you create a budget, it’s important to understand how budget types and scopes interact. Usage of metered products can count toward multiple applicable budgets at the same time, and if... | {
"source": "github-docs/billing/how-tos/set-up-budgets.md",
"title": "Setting up budgets to control spending on metered products"
} |
If you're a customer in the United States, you need to ensure that your account is set up to calculate sales tax correctly. If you're exempt from sales tax, you can upload a certificate to your account in JPEG (.jpg, .jpeg), PNG (.png), or PDF (.pdf) format.
Adding a sales tax exemption certificate to your account
En... | {
"source": "github-docs/billing/how-tos/set-up-payment/add-sales-tax-certificate.md",
"title": "Adding a sales tax certificate"
} |
You can pay for metered usage of features through Azure by connecting an Azure Subscription ID to your organization or enterprise account on . See AUTOTITLE.
Prerequisites
You must be an owner of the organization or enterprise account you want to connect to Azure.
You must know your Azure subscription ID. See Get ... | {
"source": "github-docs/billing/how-tos/set-up-payment/connect-azure-sub.md",
"title": "Connecting an Azure subscription"
} |
About the Reserve Bank of India's recurring payments regulation
A new payments regulation from the Reserve Bank of India (RBI) recently came into effect. This regulation places additional requirements on recurring online transactions and has prevented some customers in India from making recurring payments. Customers u... | {
"source": "github-docs/billing/how-tos/set-up-payment/india-one-time-payments.md",
"title": "One-time payments for customers in India"
} |
bills invoiced customers through an enterprise account on . Each invoice includes a single bill charge for all of your paid services and any instances. For more information, see AUTOTITLE.
Viewing your current invoice
1. On the "Overview" page, in the "Latest invoice" section, click View invoice to open a PDF of yo... | {
"source": "github-docs/billing/how-tos/set-up-payment/manage-enterprise-invoice.md",
"title": "Managing invoices for your enterprise"
} |
The payment methods available depend on your account type. Enterprise and organization accounts have more payment options than personal accounts. Invoiced enterprise accounts make their payments using other methods. For more information, see AUTOTITLE.
Managing payment information
Troubleshooting payment method issue... | {
"source": "github-docs/billing/how-tos/set-up-payment/manage-payment-info.md",
"title": "Managing your payment and billing information"
} |
Prerequisites
[!IMPORTANT]
can't issue a refund if you apply a coupon to the wrong account or to an account that you have already paid for.
Before you redeem a coupon:
1. Confirm which account the coupon is intended for.
1. Verify that the account you want to apply the coupon to is not already paid for, see AUTOTITL... | {
"source": "github-docs/billing/how-tos/set-up-payment/redeem-coupon.md",
"title": "Redeeming a coupon"
} |
[!NOTE] Customers with a bundle can switch to usage-based billing for licenses. This allows you to pay for licenses on a flexible monthly cycle for users who are not part of your subscription. See AUTOTITLE.
See AUTOTITLE.
Prerequisites
Your team's subscription must include . For more information, see:
Subs... | {
"source": "github-docs/billing/how-tos/set-up-payment/set-up-vs-subscription.md",
"title": "Setting up Visual Studio subscriptions with GitHub Enterprise"
} |
Message: "Need admin approval"
This message is displayed if the user account you used to sign into Azure does not have adequate permissions to install the Subscription Permission Validation app (SPV app). uses the SPV app during the connection process to get a list of available subscriptions from active directory.
N... | {
"source": "github-docs/billing/how-tos/troubleshooting/azure-sub-connection.md",
"title": "Troubleshooting Azure subscription connection problems"
} |
If your card is declined, we'll send you an email about why the payment was declined. You'll have a few days to resolve the problem before we try charging you again.
1. Check your card's expiration date and add your new card's details
Start by checking your card's expiration date.
If your card has expired, you'll need... | {
"source": "github-docs/billing/how-tos/troubleshooting/declined-card.md",
"title": "Troubleshooting a declined credit card charge"
} |
About unexpected license usage
If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see AUTOTITLE and AUTOTITLE.
[!NOTE] For privacy reasons, enterpri... | {
"source": "github-docs/billing/how-tos/troubleshooting/enterprise-license-usage.md",
"title": "Troubleshooting license usage for GitHub Enterprise"
} |
You can unlock and access your account by updating your account's payment method and resuming paid status. We do not ask you to pay for the time elapsed in locked mode.
You can downgrade your user account or organization to to continue with the same advanced features in public repositories. For more information, see A... | {
"source": "github-docs/billing/how-tos/troubleshooting/locked-account.md",
"title": "Unlocking a locked account"
} |
rounds the minutes and partial minutes each job uses up to the nearest whole minute.
x64-powered
Operating system Billing SKU Per-minute rate (USD)
--------------------- -------------------------- ---------------------
Linux Advanced 2-core linux2coreadvanced $0.006
... | {
"source": "github-docs/billing/reference/actions-runner-pricing.md",
"title": "Actions runner pricing"
} |
You can connect an Azure subscription to your account. When you do, charges for products (such as , , or ) are billed through Azure instead of directly through .
Connecting an Azure subscription allows you to consolidate invoices and manage spending within your organization’s existing Azure billing processes.
For de... | {
"source": "github-docs/billing/reference/azure-billing.md",
"title": "Billing through Azure subscriptions"
} |
Enterprises and cost centers
There’s no limit to the number of enterprises or cost centers you can connect to a single Azure subscription.
If you want to use multiple Azure subscriptions to pay for usage in one enterprise account, you need to create cost centers. You can connect each cost center to a different Azure su... | {
"source": "github-docs/billing/reference/azure-subscription.md",
"title": "Azure subscription reference"
} |
Usage reports show detailed information about your account’s usage, including how much of each SKU was used and the resulting billable amount.
To generate a usage report, see AUTOTITLE.
Report types
The following report types are available.
Metered usage page:
Summarized usage report: A summary of usage for all ... | {
"source": "github-docs/billing/reference/billing-reports.md",
"title": "Billing reports reference"
} |
The following roles have access to the billing platform:
Enterprise owners and enterprise billing managers: Can manage billing for an enterprise account.
Organization owners and organization billing managers: Can manage billing for an organization on or .
[!NOTE]
If your organization is owned by an enterprise ... | {
"source": "github-docs/billing/reference/billing-roles.md",
"title": "Roles for the billing platform"
} |
This article contains reference information for how spending is assigned to cost centers. To create and manage cost centers, see AUTOTITLE.
Overview
Breakdown by product
Product A cost center is charged if it contains this resource
------- -----------------------------------------------------
The repository ... | {
"source": "github-docs/billing/reference/cost-center-allocation.md",
"title": "Cost center allocation for different products"
} |
People who consume a license
A person consumes a license for depending on specific criteria. If a user has not yet accepted an invitation to join your enterprise, the user still consumes a license. For more information about the people in your enterprise who consume a license, see AUTOTITLE.
s
If the verified email a... | {
"source": "github-docs/billing/reference/enterprise-license-troubleshooting.md",
"title": "License troubleshooting information for GitHub Enterprise"
} |
For organizations and enterprises, the "plan" component of the bill is based on the number of licensed seats you use.
Organizations on
bills for the following people:
Organization members, including owners
Outside collaborators on private repositories owned by your organization, excluding forks
counts each out... | {
"source": "github-docs/billing/reference/github-license-users.md",
"title": "People who consume a license in an organization"
} |
Each license report shows information about license users in your enterprise account, for , or for .
Cloud users can download license reports from the Licensing page under Billing & licensing or using the REST API.
Enterprise and license users, see AUTOTITLE
license users, see AUTOTITLE
Report using the REST API... | {
"source": "github-docs/billing/reference/license-reports.md",
"title": "License reports reference"
} |
See AUTOTITLE
license report
The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your (GHEC) deployment, (GHES) connected environments, or your subscriptions (VSS) with GitHub Enterprise.
Reports generated ... | {
"source": "github-docs/billing/reference/license-reports.md",
"title": "License reports reference"
} |
When working with billing through the REST API to create budgets or query usage, you'll need to use specific product and SKU identifiers. This reference provides the valid values for these identifiers.
Product-level identifiers
For ProductPricing budgets or to query usage by product, use one of the following values:
... | {
"source": "github-docs/billing/reference/product-and-sku-names.md",
"title": "GitHub Product and SKU names"
} |
The table below shows the usage available in each plan. When you exceed these amounts, you'll be charged for additional usage unless you've set a budget with the setting "Stop usage when budget limit is reached" enabled. For more information, see AUTOTITLE.
<table
<tr
<th<bProduct</b</th
<th<bUsage type</b</t... | {
"source": "github-docs/billing/reference/product-usage-included.md",
"title": "Product usage included with each plan"
} |
is a combined offering and knowledge of roles in both systems is useful.
roles
Role Description More information
:- :- :-
Subscriptions admin Person who assigns licenses for subscription Overview of admin responsibilities in Microsoft Docs
Subscriber Person who uses a license for subscription Visual ... | {
"source": "github-docs/billing/reference/roles-for-visual-studio.md",
"title": "Roles for {% data variables.visual_studio.prodname_vss_ghe %} reference"
} |
Metered or usage-based billing options
[!NOTE]
Prepaid credit/debit cards are not accepted as a valid form of payment.
The supported payment methods for metered billing:
Invoice – Managed accounts only
Credit card – Unmanaged accounts, or as a nonrecurring method for managed accounts
PayPal – Unmanaged accounts, o... | {
"source": "github-docs/billing/reference/supported-payment-methods.md",
"title": "Supported payment methods for GitHub"
} |
After you transition to metered billing, you may want to automatically track usage and costs for paid features in your internal reporting systems. For example, you might want to monitor spend over time, reconcile invoices, or feed usage data into finance or BI tools.
In this tutorial, you’ll learn how to use the REST ... | {
"source": "github-docs/billing/tutorials/automate-usage-reporting.md",
"title": "Automating usage reporting with the REST API"
} |
Example using curl
curl -L \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage/summary
Replace ENTERPRISE with the enterprise slug and set the GITHUBTOKEN environment variable to a with the requ... | {
"source": "github-docs/billing/tutorials/automate-usage-reporting.md",
"title": "Automating usage reporting with the REST API"
} |
Example using the
gh api \
-H "X-GitHub-Api-Version: {{ defaultRestApiVersion }}" \
/enterprises/ENTERPRISE/settings/billing/usage/summary
This endpoint returns aggregated usage data for all paid products for the current year by default. Each entry includes information such as the product, unit type, quantity used... | {
"source": "github-docs/billing/tutorials/automate-usage-reporting.md",
"title": "Automating usage reporting with the REST API"
} |
Cost centers help you track and control costs by mapping them to your company's financial structure.
This tutorial guides you through planning, creating, and managing cost centers using both the user interface and the REST API, helping you decide which approach best fits your organization's needs.
As your enterprise g... | {
"source": "github-docs/billing/tutorials/control-costs-at-scale.md",
"title": "Controlling and tracking costs at scale"
} |
The billing platform provides you with the tools to:
Get insights into usage trends to understand how your resources are being used.
Search and filter usage by repository, product, or SKU, and group data accordingly.
Generate reports on past usage for various time periods, including the current hour, today, this mon... | {
"source": "github-docs/billing/tutorials/gather-insights.md",
"title": "Gathering insights on your spending"
} |
About soft budgets
Soft budgets set spending targets without enforcing limits. When spending exceeds the budget, billing managers and enterprise owners receive email notifications, but usage continues uninterrupted.
Soft budgets are especially useful when:
You’re new to managing costs across multiple products or SKUs
... | {
"source": "github-docs/billing/tutorials/soft-budgets.md",
"title": "Start monitoring costs with soft budgets"
} |
When you use automatic setup for code coverage, an AI-powered agent analyzes your repository, identifies your test framework, and opens a pull request with a coverage workflow ready for review.
There is no additional cost for using this feature.
How the agent works
The agent works in three phases:
1. Discovery: The ag... | {
"source": "github-docs/code-security/concepts/code-quality/automatic-code-coverage-setup.md",
"title": "Automatic code coverage setup"
} |
analyzes your code for quality and coverage issues and delivers -powered fixes you can apply in one click. It runs in two places:
On pull requests, findings appear as inline comments before code is merged. If you upload a Cobertura XML coverage report, coverage metrics show whether a change maintains or reduces covera... | {
"source": "github-docs/code-security/concepts/code-quality/code-quality.md",
"title": "GitHub Code Quality"
} |
How enablement works across your enterprise
is controlled at three levels, so you can decide how much autonomy to give organizations and repositories:
Enterprise: An enterprise owner must first allow for the enterprise. Until they do, organization owners cannot enable it.
Organization: Organization owners control w... | {
"source": "github-docs/code-security/concepts/code-quality/enablement-at-scale.md",
"title": "Code Quality enablement across organizations and enterprises"
} |
[!NOTE]
AI-powered security detections are currently in and subject to change.
AI-powered security detections are additional security findings produced by an AI-based scanning engine that runs on pull requests and complements . Unlike alerts, AI-powered findings are only available on pull requests and do not appear ... | {
"source": "github-docs/code-security/concepts/code-scanning/ai-powered-security-detections.md",
"title": "AI-powered security detections in pull requests"
} |
How alert-to-issue linking works
When identifies a vulnerability in your code, you can link the alert to a issue to track remediation work. This brings security fixes into your existing planning and project management workflow, making vulnerabilities visible in sprint planning, project boards, and team backlogs.
Each... | {
"source": "github-docs/code-security/concepts/code-scanning/alert-tracking-with-issues.md",
"title": "Code scanning alert tracking using issues"
} |
Autofix provides you with targeted recommendations to help you fix alerts so you can avoid introducing new security vulnerabilities. The potential fixes are generated automatically by large language models (LLMs) using data from the codebase and from analysis.
How autofix works
Autofix translates the description and... | {
"source": "github-docs/code-security/concepts/code-scanning/autofix-for-code-scanning.md",
"title": "About autofix for code scanning"
} |
About alerts from
You can configure to check the code in a repository using the default analysis, a third-party analysis, or multiple types of analysis. When the analysis is complete, the resulting alerts are displayed alongside each other in the security view of the repository. Results from third-party tools or fro... | {
"source": "github-docs/code-security/concepts/code-scanning/code-scanning-alerts.md",
"title": "Code scanning alerts"
} |
You can use to find, triage, and prioritize fixes for existing problems in your code. also prevents developers from introducing new problems. You can schedule scans for specific days and times, or trigger scans when a specific event occurs in the repository, such as a push.
If finds a potential vulnerability or erro... | {
"source": "github-docs/code-security/concepts/code-scanning/code-scanning.md",
"title": "Code scanning"
} |
Software developers and security researchers can secure their code
using analysis. For more information about , see AUTOTITLE.
The is a standalone, command-line tool that you can use to analyze code. Its main purpose is to generate a database representation of a codebase, a database. Once the database is ready, you ... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/codeql-cli.md",
"title": "CodeQL CLI"
} |
There are three main ways to use analysis for :
Use default setup to quickly configure analysis for on your repository. Default setup automatically chooses the languages to analyze, query suite to run, and events that trigger scans. If you prefer, you can manually select the query suite to run and languages to anal... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/codeql-code-scanning.md",
"title": "Code scanning with CodeQL"
} |
About the and compiled languages
works by running queries against one or more databases. Each database contains a representation of the code in a single language in your repository. For the compiled languages , the process of populating this database often involves building the code and extracting data.
When you ena... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/codeql-for-compiled-languages.md",
"title": "CodeQL code scanning for compiled languages"
} |
About for
You can run queries on databases generated from source code, in order to find errors and security vulnerabilities in a codebase. For more information about , see AUTOTITLE.
With the for extension, you can:
Write custom queries and supporting libraries.
Directly view and use the security queries from... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/codeql-for-vs-code.md",
"title": "CodeQL for VS Code"
} |
What are query suites?
Query suites allow you to pass multiple queries to without having to specify the path to each query file individually. They provide a way of selecting queries based on their filename, metadata properties, or location on disk or in a pack.
You should use query suites for the queries that you wan... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/codeql-query-suites.md",
"title": "CodeQL query suites"
} |
About workspaces
A workspace is typically used to develop a set of library and query packs that depend on each other. When you use a workspace, all the packs in the workspace are available as source dependencies for each other when you run a command that resolves queries. This makes it easier to develop, maintain,... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/codeql-workspaces.md",
"title": "CodeQL workspaces"
} |
What are custom queries?
Custom queries extend 's built-in security analysis to detect vulnerabilities, coding standards, and patterns specific to your codebase.
When to use custom queries
Use custom queries to:
Detect vulnerabilities specific to your application's architecture or frameworks
Enforce organization-sp... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/custom-queries.md",
"title": "Custom CodeQL queries"
} |
About packs
packs are used to create, share, depend on, and run queries and libraries. You can customize your analysis by downloading packs created by others and running them on your codebase.
Each pack requires a qlpack.yml file in its root directory that specifies:
How to compile the queries
Dependencies on ot... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/query-packs.md",
"title": "CodeQL query packs"
} |
About query reference files
A query reference file is text file that defines the location of one query to test.
You use a query reference file when you want to tell the test run subcommand
to run a query that’s not part of a test directory.
There are two ways to specify queries that you want to run as tests:
1. Use a q... | {
"source": "github-docs/code-security/concepts/code-scanning/codeql/query-reference-files.md",
"title": "Query reference files"
} |
About integration with code scanning
As an alternative to running within , you can perform analysis elsewhere, using the CodeQL CLI or another static analysis tool, and then upload the results. For more information, see AUTOTITLE.
Integrations with webhooks
You can use webhooks to build or configure integrations, su... | {
"source": "github-docs/code-security/concepts/code-scanning/integration-with-code-scanning.md",
"title": "Integration with code scanning"
} |
Rulesets for merge protection
A ruleset is a named list of rules that control how people can interact with branches and tags in your repositories. You can add rules to rulesets to prevent pull requests from being merged when any of the following conditions are met:
Typically, you should use merge protection on long-... | {
"source": "github-docs/code-security/concepts/code-scanning/merge-protection.md",
"title": "Code scanning merge protection"
} |
About MRVA
With multi-repository variant analysis (MRVA), you can run queries on a list of up to 1,000 repositories on from .
When you run MRVA against a list of repositories, your query is run against each repository that has a database available to analyze. creates and stores the latest database for the default ... | {
"source": "github-docs/code-security/concepts/code-scanning/multi-repository-variant-analysis.md",
"title": "Multi-repository variant analysis"
} |
Overview
The metrics overview for pull request alerts on security overview helps you understand how well is preventing vulnerabilities in pull requests in your organization or across organizations in your enterprise. You can view the entire dataset or filter for specific criteria, making it easy to identify repositor... | {
"source": "github-docs/code-security/concepts/code-scanning/pull-request-alert-metrics.md",
"title": "CodeQL pull request alert metrics"
} |
Prerequisites
For the repository properties described here to have an effect, you need to have set up . See AUTOTITLE.
Repository properties which affect must be created manually for your organization. You can then set values for them that apply to your entire organization or allow them to be configured differently fo... | {
"source": "github-docs/code-security/concepts/code-scanning/repository-properties.md",
"title": "Repository properties for {% data variables.product.prodname_code_scanning %}"
} |
The is a free, self-serve scan that helps you understand your organization's exposure to code vulnerabilities. The assessment scans up to 20 of your organization's repositories and produces a report showing the vulnerabilities found, their severity, and how many can be fixed with .
The assessment is completely free. Y... | {
"source": "github-docs/code-security/concepts/code-scanning/risk-assessment.md",
"title": "Code security risk assessment"
} |
[!NOTE] If you use default setup for , or an advanced setup that involves using to run the action, then you don't need to interact with SARIF files. Scan results are uploaded and parsed as alerts automatically.
SARIF stands for Static Analysis Results Interchange Format. This is a JSON-based standard for storing res... | {
"source": "github-docs/code-security/concepts/code-scanning/sarif-files.md",
"title": "About SARIF files for code scanning"
} |
About default setup
Default setup for is the quickest, easiest, most low-maintenance way to enable for your repository. Based on the code in your repository, default setup will automatically create a custom configuration. You can also customize this configuration, including at scale across your organization, without... | {
"source": "github-docs/code-security/concepts/code-scanning/setup-types.md",
"title": "About setup types for code scanning"
} |
What is the ?
The shows information about all of your tools and is a good starting point for debugging problems when isn't working as expected.
[!NOTE]
The shows tool status at the repository level for the default branch only, not at the organization level.
Tool status indicators
The displays one of three statu... | {
"source": "github-docs/code-security/concepts/code-scanning/tool-status-page.md",
"title": "About the tool status page"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.