计费使用 - GitHub 文档

本页的端点返回计费到与该端点关联的账户的使用情况。有关如何决定报告哪一层级的使用情况的帮助，请参阅使用 REST API 自动化使用报告。

用户端点返回直接计费到个人用户账户的 Copilot 使用情况。仅当用户自行购买了 Copilot 计划时，这些端点才适用。
如果用户的 Copilot 许可证是通过组织或企业进行管理和计费的，则其使用情况不包括在用户层级端点中。在这种情况下，必须改用组织或企业层级的端点。

要查看企业层级端点，请在页面顶部的下拉菜单中将视图从 Free、Pro、& Team 切换为 GitHub Enterprise Cloud。

获取组织的计费高级请求使用报告

获取组织的高级请求使用报告。要使用此端点，您必须是企业内组织或组织账户的管理员。

注意：仅可通过此端点访问过去 24 个月的数据。

针对 “获取组织的计费高级请求使用报告” 的细粒度访问令牌

此端点支持以下细粒度令牌类型:

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

组织的 “Administration” 权限（读取）

针对 “获取组织的计费高级请求使用报告” 的参数

标头 (Headers)
名称, 类型, 描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称, 类型, 描述
`org` string 必需组织名称。该名称不区分大小写。

查询参数
名称, 类型, 描述
`year` integer 如果指定，仅返回单一年份的结果。`year` 的值为四位整数，表示年份，例如 `2025`。默认值为当前年份。
`month` integer 如果指定，仅返回单个月份的结果。`month` 的值为 1 到 12 之间的整数。默认值为当前月份。如果未指定年份，则使用默认的 `year`。
`day` integer 如果指定，仅返回单天的结果。`day` 的值为 1 到 31 之间的整数。如果未指定 `year` 或 `month`，则使用默认的年份和月份。
`user` string 要查询使用情况的用户名。名称不区分大小写。
`model` string 要查询使用情况的模型名称。名称不区分大小写。
`product` string 要查询使用情况的产品名称。名称不区分大小写。

针对 “获取组织的计费高级请求使用报告” 的 HTTP 响应状态码

状态码	描述
`200`	获取计费高级请求使用报告时的响应
`400`	错误的请求
`403`	禁止 (Forbidden)
`404`	未找到资源
`500`	内部错误
`503`	服务不可用

针对 “获取组织的计费高级请求使用报告” 的代码示例

请求示例

get/organizations/{org}/settings/billing/premium_request/usage

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/organizations/ORG/settings/billing/premium_request/usage

获取计费高级请求使用报告时的响应

状态: 200

{ "timePeriod": { "year": 2025 }, "organization": "GitHub", "usageItems": [ { "product": "Copilot", "sku": "Copilot Premium Request", "model": "GPT-5", "unitType": "requests", "pricePerUnit": 0.04, "grossQuantity": 100, "grossAmount": 4, "discountQuantity": 0, "discountAmount": 0, "netQuantity": 100, "netAmount": 4 } ] }

获取组织的计费使用报告

获取组织的总体使用报告。要使用此端点，您必须是企业内组织或组织账户的管理员。

注意：此端点仅对拥有增强计费平台访问权限的组织可用。更多信息请参阅关于增强计费平台。

针对 “获取组织的计费使用报告” 的细粒度访问令牌

此端点支持以下细粒度令牌类型:

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

组织的 “Administration” 权限（读取）

针对 “获取组织的计费使用报告” 的参数

标头 (Headers)
名称, 类型, 描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称, 类型, 描述
`org` string 必需组织名称。该名称不区分大小写。

查询参数
名称, 类型, 描述
`year` integer 如果指定，仅返回单一年份的结果。`year` 的值为四位整数，表示年份，例如 `2025`。默认值为当前年份。
`month` integer 如果指定，仅返回单个月份的结果。`month` 的值为 1 到 12 之间的整数。如果未指定年份，则使用默认的 `year`。
`day` integer 如果指定，仅返回单天的结果。`day` 的值为 1 到 31 之间的整数。如果未指定 `year` 或 `month`，则使用默认的年份和月份。

针对 “获取组织的计费使用报告” 的 HTTP 响应状态码

状态码	描述
`200`	组织的计费使用报告响应
`400`	错误的请求
`403`	禁止 (Forbidden)
`500`	内部错误
`503`	服务不可用

针对 “获取组织的计费使用报告” 的代码示例

请求示例

get/organizations/{org}/settings/billing/usage

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/organizations/ORG/settings/billing/usage

组织的计费使用报告响应

状态: 200

{ "usageItems": [ { "date": "2023-08-01", "product": "Actions", "sku": "Actions Linux", "quantity": 100, "unitType": "minutes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] }

获取组织的计费使用汇总

注意

此端点处于公开预览阶段，可能会更改。

获取组织的使用汇总报告。要使用此端点，您必须是企业内组织或组织账户的管理员。

注意：仅可通过此端点访问过去 24 个月的数据。

针对 “获取组织的计费使用汇总” 的细粒度访问令牌

此端点支持以下细粒度令牌类型:

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

组织的 “Administration” 权限（读取）

针对 “获取组织的计费使用汇总” 的参数

标头 (Headers)
名称, 类型, 描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称, 类型, 描述
`org` string 必需组织名称。该名称不区分大小写。

查询参数
名称, 类型, 描述
`year` integer 如果指定，仅返回单一年份的结果。`year` 的值为四位整数，表示年份，例如 `2025`。默认值为当前年份。
`month` integer 如果指定，仅返回单个月份的结果。`month` 的值为 1 到 12 之间的整数。默认值为当前月份。如果未指定年份，则使用默认的 `year`。
`day` integer 如果指定，仅返回单天的结果。`day` 的值为 1 到 31 之间的整数。如果未指定 `year` 或 `month`，则使用默认的年份和月份。
`repository` string 要查询使用情况的仓库名称，格式为 owner/repository。
`product` string 要查询使用情况的产品名称。名称不区分大小写。
`sku` string 要查询使用情况的 SKU。

针对 “获取组织的计费使用汇总” 的 HTTP 响应状态码

状态码	描述
`200`	获取计费使用汇总时的响应
`400`	错误的请求
`403`	禁止 (Forbidden)
`500`	内部错误
`503`	服务不可用

针对 “获取组织的计费使用汇总” 的代码示例

请求示例

get/organizations/{org}/settings/billing/usage/summary

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/organizations/ORG/settings/billing/usage/summary

获取计费使用汇总时的响应

状态: 200

{ "timePeriod": { "year": 2025 }, "organization": "GitHub", "usageItems": [ { "product": "Actions", "sku": "actions_linux", "unitType": "minutes", "pricePerUnit": 0.008, "grossQuantity": 1000, "grossAmount": 8, "discountQuantity": 0, "discountAmount": 0, "netQuantity": 1000, "netAmount": 8 } ] }

获取用户的计费高级请求使用报告

获取用户的高级请求使用报告。

注意：仅可通过此端点访问过去 24 个月的数据。

针对 “获取用户的计费高级请求使用报告” 的细粒度访问令牌

此端点支持以下细粒度令牌类型:

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

“Plan” 用户权限（读取）

针对 “获取用户的计费高级请求使用报告” 的参数

标头 (Headers)
名称, 类型, 描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称, 类型, 描述
`username` 字符串必需 GitHub 用户账户的句柄。

查询参数
名称, 类型, 描述
`year` integer 如果指定，仅返回单一年份的结果。`year` 的值为四位整数，表示年份，例如 `2025`。默认值为当前年份。
`month` integer 如果指定，仅返回单个月份的结果。`month` 的值为 1 到 12 之间的整数。默认值为当前月份。如果未指定年份，则使用默认的 `year`。
`day` integer 如果指定，仅返回单天的结果。`day` 的值为 1 到 31 之间的整数。如果未指定 `year` 或 `month`，则使用默认的年份和月份。
`model` string 要查询使用情况的模型名称。名称不区分大小写。
`product` string 要查询使用情况的产品名称。名称不区分大小写。

针对 “获取用户的计费高级请求使用报告” 的 HTTP 响应状态码

状态码	描述
`200`	获取计费高级请求使用报告时的响应
`400`	错误的请求
`403`	禁止 (Forbidden)
`404`	未找到资源
`500`	内部错误
`503`	服务不可用

针对 “获取用户的计费高级请求使用报告” 的代码示例

请求示例

get/users/{username}/settings/billing/premium_request/usage

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/settings/billing/premium_request/usage

获取计费高级请求使用报告时的响应

状态: 200

{ "timePeriod": { "year": 2025 }, "user": "monalisa", "usageItems": [ { "product": "Copilot", "sku": "Copilot Premium Request", "model": "GPT-5", "unitType": "requests", "pricePerUnit": 0.04, "grossQuantity": 100, "grossAmount": 4, "discountQuantity": 0, "discountAmount": 0, "netQuantity": 100, "netAmount": 4 } ] }

获取用户的计费使用报告

获取用户的总体使用报告。

注意：此端点仅对拥有增强计费平台访问权限的用户可用。

针对 “获取用户的计费使用报告” 的细粒度访问令牌

此端点支持以下细粒度令牌类型:

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

“Plan” 用户权限（读取）

针对 “获取用户的计费使用报告” 的参数

标头 (Headers)
名称, 类型, 描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称, 类型, 描述
`username` 字符串必需 GitHub 用户账户的句柄。

查询参数
名称, 类型, 描述
`year` integer 如果指定，仅返回单一年份的结果。`year` 的值为四位整数，表示年份，例如 `2025`。默认值为当前年份。
`month` integer 如果指定，仅返回单个月份的结果。`month` 的值为 1 到 12 之间的整数。如果未指定年份，则使用默认的 `year`。
`day` integer 如果指定，仅返回单天的结果。`day` 的值为 1 到 31 之间的整数。如果未指定 `year` 或 `month`，则使用默认的年份和月份。

针对 “获取用户的计费使用报告” 的 HTTP 响应状态码

状态码	描述
`200`	获取计费使用报告时的响应
`400`	错误的请求
`403`	禁止 (Forbidden)
`500`	内部错误
`503`	服务不可用

针对 “获取用户的计费使用报告” 的代码示例

请求示例

get/users/{username}/settings/billing/usage

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/settings/billing/usage

获取计费使用报告时的响应

状态: 200

{ "usageItems": [ { "date": "2023-08-01", "product": "Actions", "sku": "Actions Linux", "quantity": 100, "unitType": "minutes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "repositoryName": "user/example" } ] }

获取用户的计费使用汇总

注意

此端点处于公开预览阶段，可能会更改。

获取用户的使用汇总报告。

注意：仅可通过此端点访问过去 24 个月的数据。

针对 “获取用户的计费使用汇总” 的细粒度访问令牌

此端点支持以下细粒度令牌类型:

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

“Plan” 用户权限（读取）

针对 “获取用户的计费使用汇总” 的参数

标头 (Headers)
名称, 类型, 描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称, 类型, 描述
`username` 字符串必需 GitHub 用户账户的句柄。

查询参数
名称, 类型, 描述
`year` integer 如果指定，仅返回单一年份的结果。`year` 的值为四位整数，表示年份，例如 `2025`。默认值为当前年份。
`month` integer 如果指定，仅返回单个月份的结果。`month` 的值为 1 到 12 之间的整数。默认值为当前月份。如果未指定年份，则使用默认的 `year`。
`day` integer 如果指定，仅返回单天的结果。`day` 的值为 1 到 31 之间的整数。如果未指定 `year` 或 `month`，则使用默认的年份和月份。
`repository` string 要查询使用情况的仓库名称，格式为 owner/repository。
`product` string 要查询使用情况的产品名称。名称不区分大小写。
`sku` string 要查询使用情况的 SKU。

针对 “获取用户的计费使用汇总” 的 HTTP 响应状态码

状态码	描述
`200`	获取计费使用汇总时的响应
`400`	错误的请求
`403`	禁止 (Forbidden)
`404`	未找到资源
`500`	内部错误
`503`	服务不可用

针对 “获取用户的计费使用汇总” 的代码示例

请求示例

get/users/{username}/settings/billing/usage/summary

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ https://api.github.com/users/USERNAME/settings/billing/usage/summary

获取计费使用汇总时的响应

状态: 200

{ "timePeriod": { "year": 2025 }, "user": "monalisa", "usageItems": [ { "product": "Actions", "sku": "actions_linux", "unitType": "minutes", "pricePerUnit": 0.008, "grossQuantity": 1000, "grossAmount": 8, "discountQuantity": 0, "discountAmount": 0, "netQuantity": 1000, "netAmount": 8 } ] }