REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制."

用于计费的 REST API 端点

使用 REST API 获取企业计费信息。

关于账单

您可以获取企业账单信息。有关更多信息，请参阅“企业账单的 REST API 端点”。

获取组织的 GitHub Actions 账单

获取免费和付费 GitHub Actions 使用分钟数的摘要。

付费分钟数仅适用于使用 GitHub 托管运行器在私有存储库中运行的工作流。每个 GitHub 托管运行器操作系统都列出了使用的分钟数。任何作业重新运行也包含在使用情况中。返回的使用情况包括 macOS 和 Windows 运行器的任何分钟数乘数，并四舍五入到最接近的整分钟。有关更多信息，请参阅“管理 GitHub Actions 的账单”。

OAuth 应用令牌和个人访问令牌（经典）需要 repo 或 admin:org 范围才能使用此端点。

用于“获取组织的 GitHub Actions 账单”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”组织权限（读取）

用于“获取组织的 GitHub Actions 账单”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
org string 必需

组织名称。名称不区分大小写。

用于“获取组织的 GitHub Actions 账单”的 HTTP 响应状态代码

状态代码描述
200

OK

用于“获取组织的 GitHub Actions 账单”的代码示例

请求示例

get/orgs/{org}/settings/billing/actions
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/settings/billing/actions

响应

状态：200
{ "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }

获取组织的 GitHub Packages 账单

获取 GitHub Packages 中用于私有仓库的免费和付费存储量（以 GB 为单位）。

付费分钟数仅适用于存储在私有仓库中的软件包。有关更多信息，请参阅 "管理 GitHub Packages 的账单."

OAuth 应用令牌和个人访问令牌（经典）需要 repo 或 admin:org 范围才能使用此端点。

用于“获取组织的 GitHub Packages 账单”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”组织权限（读取）

用于“获取组织的 GitHub Packages 账单”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
org string 必需

组织名称。名称不区分大小写。

用于“获取组织的 GitHub Packages 账单”的 HTTP 响应状态代码

状态代码描述
200

OK

用于“获取组织的 GitHub Packages 账单”的代码示例

请求示例

get/orgs/{org}/settings/billing/packages
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/settings/billing/packages

响应

状态：200
{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }

获取组织的共享存储账单

获取 GitHub Actions 和 GitHub Packages 的估计付费存储量和估计总存储量。

付费分钟数仅适用于存储在私有仓库中的软件包。有关更多信息，请参阅 "管理 GitHub Packages 的账单."

OAuth 应用令牌和个人访问令牌（经典）需要 repo 或 admin:org 范围才能使用此端点。

用于“获取组织的共享存储账单”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “管理”组织权限（读取）

用于“获取组织的共享存储账单”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
org string 必需

组织名称。名称不区分大小写。

用于“获取组织的共享存储账单”的 HTTP 响应状态代码

状态代码描述
200

OK

用于“获取组织的共享存储账单”的代码示例

请求示例

get/orgs/{org}/settings/billing/shared-storage
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/settings/billing/shared-storage

响应

状态：200
{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }

获取用户的 GitHub Actions 账单

获取免费和付费 GitHub Actions 使用分钟数的摘要。

付费分钟数仅适用于使用 GitHub 托管运行器在私有存储库中运行的工作流。每个 GitHub 托管运行器操作系统都列出了使用的分钟数。任何作业重新运行也包含在使用情况中。返回的使用情况包括 macOS 和 Windows 运行器的任何分钟数乘数，并四舍五入到最接近的整分钟。有关更多信息，请参阅“管理 GitHub Actions 的账单”。

OAuth 应用令牌和个人访问令牌（经典）需要 user 范围才能使用此端点。

针对“获取 GitHub Actions 用户账单”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “计划”用户权限（读取）

“获取 GitHub Actions 用户账单”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必填

GitHub 用户帐户的句柄。

“获取 GitHub Actions 用户账单”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取 GitHub Actions 用户账单”的代码示例

请求示例

get/users/{username}/settings/billing/actions
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/settings/billing/actions

响应

状态：200
{ "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } }

获取 GitHub Packages 用户账单

获取 GitHub Packages 中用于私有仓库的免费和付费存储量（以 GB 为单位）。

付费分钟数仅适用于存储在私有仓库中的软件包。有关更多信息，请参阅 "管理 GitHub Packages 的账单."

OAuth 应用令牌和个人访问令牌（经典）需要 user 范围才能使用此端点。

针对“获取 GitHub Packages 用户账单”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “计划”用户权限（读取）

“获取 GitHub Packages 用户账单”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必填

GitHub 用户帐户的句柄。

“获取 GitHub Packages 用户账单”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取 GitHub Packages 用户账单”的代码示例

请求示例

get/users/{username}/settings/billing/packages
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/settings/billing/packages

响应

状态：200
{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }

获取用户共享存储账单

获取 GitHub Actions 和 GitHub Packages 的估计付费存储量和估计总存储量。

付费分钟数仅适用于存储在私有仓库中的软件包。有关更多信息，请参阅 "管理 GitHub Packages 的账单."

OAuth 应用令牌和个人访问令牌（经典）需要 user 范围才能使用此端点。

针对“获取用户共享存储账单”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “计划”用户权限（读取）

“获取用户共享存储账单”的参数

标头
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必填

GitHub 用户帐户的句柄。

“获取用户共享存储账单”的 HTTP 响应状态代码

状态代码描述
200

OK

“获取用户共享存储账单”的代码示例

请求示例

get/users/{username}/settings/billing/shared-storage
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/settings/billing/shared-storage

响应

状态：200
{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }