REST API はバージョン化されました。詳細については、「API のバージョン管理について」を参照してください。

予算

REST API を使用して予算情報を取得します。

重要

以下の要求本文スキーマに必須フィールドがありません。 budget_scopeがuserされている場合は、予算が適用されるuserユーザー名に設定されたGitHubフィールドも含める必要があります。このフィールドを省略すると、API は HTTP 400: Missing required fields: budget_entity_name返します。ユーザースコープの予算の場合、 budget_entity_name は空の文字列にすることができます。

次の例では、1 人のユーザーの毎月の CopilotAI credits を $30 USD に制限するユーザースコープの予算を作成します。

{
  "budget_amount": 30,
  "prevent_further_usage": true,
  "budget_scope": "user",
  "budget_entity_name": "",
  "budget_type": "BundlePricing",
  "budget_product_sku": "ai_credits",
  "budget_alerting": {
    "will_alert": false,
    "alert_recipients": []
  },
  "user": "USERNAME"
}

Get all budgets

Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager. Each page returns up to 100 budgets.

"Get all budgets" のきめ細かいアクセストークン

このエンドポイントは、GitHubアプリユーザーアクセストークン、GitHub アプリインストールアクセストークン、またはきめ細かい個人用アクセストークンでは機能しません。

"Get all budgets" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.

クエリパラメーター
名前, タイプ, 説明
`page` integer The page number of results to fetch. デフォルト: `1`
`per_page` integer The number of results per page (max 100). デフォルト: `10`
`scope` string Filter budgets by scope type. 次のいずれかにできます: `enterprise`, `organization`, `repository`, `cost_center`, `multi_user_customer`, `user`
`user` string Filter consumed amount details for budgets by the specified user login.

"Get all budgets" の HTTP 応答状態コード

状態コード	説明
`200`	Response when getting all budgets
`403`	Forbidden
`404`	Resource not found

"Get all budgets" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

リクエスト例

Select the example type

get/enterprises/{enterprise}/settings/billing/budgets

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/enterprises/ENTERPRISE/settings/billing/budgets

Response when getting all budgets

Status: 200

{
  "budgets": [
    {
      "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
      "budget_type": "ProductPricing",
      "budget_product_skus": [
        "actions"
      ],
      "budget_scope": "enterprise",
      "budget_amount": 1000,
      "prevent_further_usage": true,
      "budget_alerting": {
        "will_alert": true,
        "alert_recipients": [
          "enterprise-admin",
          "billing-manager"
        ]
      }
    },
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "budget_type": "SkuPricing",
      "budget_product_skus": [
        "actions_linux"
      ],
      "budget_scope": "organization",
      "budget_amount": 500,
      "prevent_further_usage": false,
      "budget_alerting": {
        "will_alert": true,
        "alert_recipients": [
          "org-owner"
        ]
      }
    },
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "budget_type": "ProductPricing",
      "budget_product_skus": [
        "packages"
      ],
      "budget_scope": "cost_center",
      "budget_amount": 250,
      "prevent_further_usage": true,
      "budget_alerting": {
        "will_alert": false,
        "alert_recipients": []
      }
    }
  ],
  "has_next_page": false,
  "total_count": 3
}

Create a budget

Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

"Create a budget" のきめ細かいアクセストークン

"Create a budget" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.

名前, タイプ, 説明

budget_amount integer 必須

The budget amount in whole dollars. For license-based products, this represents the number of licenses.

prevent_further_usage boolean 必須

Whether to prevent additional spending once the budget is exceeded. For user and multi_user_customer scopes, this must be true.

budget_alerting object 必須

Properties of budget_alerting

名前, タイプ, 説明
`will_alert` boolean 必須 Whether alerts are enabled for this budget
`alert_recipients` array of strings 必須 Array of user login names who will receive alerts

budget_scope string 必須

The scope of the budget. user and multi_user_customer scopes are only supported when budget_product_sku is ai_credits or premium_requests.

次のいずれかにできます: enterprise, organization, repository, cost_center, multi_user_customer, user

budget_entity_name string

The name of the entity to apply the budget to

デフォルト: ""

budget_type string 必須

The type of pricing model used by the budget. Determines how budget_product_sku is interpreted.

BundlePricing: Covers all AI credit SKUs. Set budget_product_sku to ai_credits.
ProductPricing: Covers all SKUs that belong to a product. Set budget_product_sku to a product such as actions or packages.
SkuPricing: Covers a single, specific SKU. Set budget_product_sku to a SKU such as actions_linux.

budget_product_sku string

A single product or SKU that will be covered in the budget

user string

The username of the user for user scope budgets. This field is required when budget_scope is user.

"Create a budget" の HTTP 応答状態コード

状態コード	説明
`200`	Budget created successfully
`400`	Bad Request
`401`	Requires authentication
`403`	Forbidden
`404`	Feature not enabled
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal server error

"Create a budget" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

要求の例

post/enterprises/{enterprise}/settings/billing/budgets

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/budgets \
  -d '{"budget_amount":200,"prevent_further_usage":true,"budget_scope":"enterprise","budget_entity_name":"","budget_type":"ProductPricing","budget_product_sku":"actions","budget_alerting":{"will_alert":false,"alert_recipients":[]}}'

Budget created successfully

Status: 200

{
  "message": "Budget successfully created.",
  "budget": {
    "id": "f5236c62-157f-4d8f-a79e-ffb91058ee97",
    "budget_type": "ProductPricing",
    "budget_product_sku": "actions",
    "budget_scope": "organization",
    "budget_entity_name": "example-organization",
    "budget_amount": 100,
    "prevent_further_usage": true,
    "budget_alerting": {
      "will_alert": false,
      "alert_recipients": []
    }
  }
}

Get a budget by ID

Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.

"Get a budget by ID" のきめ細かいアクセストークン

"Get a budget by ID" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`budget_id` string 必須 The ID corresponding to the budget.

"Get a budget by ID" の HTTP 応答状態コード

状態コード	説明
`200`	Response when updating a budget
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error
`503`	Service unavailable

"Get a budget by ID" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

要求の例

get/enterprises/{enterprise}/settings/billing/budgets/{budget_id}

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/enterprises/ENTERPRISE/settings/billing/budgets/BUDGET_ID

Response when updating a budget

Status: 200

{
  "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
  "budget_type": "ProductPricing",
  "budget_product_sku": "actions_linux",
  "budget_scope": "repository",
  "budget_entity_name": "example-repo-name",
  "budget_amount": 0,
  "prevent_further_usage": true,
  "budget_alerting": {
    "will_alert": true,
    "alert_recipients": [
      "mona",
      "lisa"
    ]
  }
}

Update a budget

Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

"Update a budget" のきめ細かいアクセストークン

"Update a budget" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name
`budget_id` string 必須 The unique identifier of the budget

名前, タイプ, 説明

budget_amount integer

The budget amount in whole dollars. For license-based products, this represents the number of licenses.

prevent_further_usage boolean

Whether to prevent additional spending once the budget is exceeded. For budgets with user or multi_user_customer scope, this must remain true.

budget_alerting object

Properties of budget_alerting

名前, タイプ, 説明
`will_alert` boolean Whether alerts are enabled for this budget
`alert_recipients` array of strings Array of user login names who will receive alerts

budget_scope string

The scope of the budget

次のいずれかにできます: enterprise, organization, repository, cost_center, multi_user_customer, user

budget_entity_name string

The name of the entity to apply the budget to

budget_type string

The type of pricing model used by the budget. Determines how budget_product_sku is interpreted.

BundlePricing: Covers all AI credit SKUs. Set budget_product_sku to ai_credits.
ProductPricing: Covers all SKUs that belong to a product. Set budget_product_sku to a product such as actions or packages.
SkuPricing: Covers a single, specific SKU. Set budget_product_sku to a SKU such as actions_linux.

budget_product_sku string

A single product or SKU that will be covered in the budget

user string

The username of the user for user scope budgets.

"Update a budget" の HTTP 応答状態コード

状態コード	説明
`200`	Budget updated successfully
`400`	Bad Request
`401`	Requires authentication
`403`	Forbidden
`404`	Budget not found or feature not enabled
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal server error
`503`	Service unavailable

"Update a budget" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

要求の例

patch/enterprises/{enterprise}/settings/billing/budgets/{budget_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/budgets/BUDGET_ID \
  -d '{"prevent_further_usage":false,"budget_amount":10,"budget_alerting":{"will_alert":false,"alert_recipients":[]}}'

Budget updated successfully

Status: 200

{
  "message": "Budget successfully updated.",
  "budget": {
    "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
    "budget_type": "ProductPricing",
    "budget_product_sku": "actions_linux",
    "budget_scope": "repository",
    "budget_entity_name": "org-name/example-repo-name",
    "budget_amount": 10,
    "prevent_further_usage": true,
    "budget_alerting": {
      "will_alert": true,
      "alert_recipients": [
        "mona",
        "lisa"
      ]
    }
  }
}

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`enterprise` string 必須 The slug version of the enterprise name.
`budget_id` string 必須 The ID corresponding to the budget.

"Delete a budget" の HTTP 応答状態コード

状態コード	説明
`200`	Response when deleting a budget
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error
`503`	Service unavailable

"Delete a budget" のコードサンプル

GHE.com でGitHubにアクセスする場合は、api.github.com を、api.SUBDOMAIN.ghe.com にある企業の専用サブドメインに置き換えます。

要求の例

delete/enterprises/{enterprise}/settings/billing/budgets/{budget_id}

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

Response when deleting a budget

Status: 200

{
  "message": "Budget successfully deleted.",
  "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b"
}

予算

Get all budgets

"Get all budgets" のきめ細かいアクセストークン

"Get all budgets" のパラメーター

"Get all budgets" の HTTP 応答状態コード

"Get all budgets" のコードサンプル

リクエスト例

Response when getting all budgets

Create a budget

"Create a budget" のきめ細かいアクセストークン

"Create a budget" のパラメーター

"Create a budget" の HTTP 応答状態コード

"Create a budget" のコードサンプル

要求の例

Budget created successfully

Get a budget by ID

"Get a budget by ID" のきめ細かいアクセストークン

"Get a budget by ID" のパラメーター

"Get a budget by ID" の HTTP 応答状態コード

"Get a budget by ID" のコードサンプル

要求の例

Response when updating a budget

Update a budget

"Update a budget" のきめ細かいアクセストークン

"Update a budget" のパラメーター

"Update a budget" の HTTP 応答状態コード

"Update a budget" のコードサンプル

要求の例

Budget updated successfully

Delete a budget

"Delete a budget" のきめ細かいアクセストークン

"Delete a budget" のパラメーター

"Delete a budget" の HTTP 応答状態コード

"Delete a budget" のコードサンプル

要求の例

Response when deleting a budget