Sign in
latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-201,4701,08213.3 MB

905703de9c0f

billing

Update a budget

Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it. Organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. A custom role holder with fine-grained write access to enterprise billing can update budgets scoped to a single user or a cost center, including all users in a cost center, without an additional administrator role; the role requirements above still apply to the other scopes. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.

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

Path parameters

enterprisestring required

The slug version of the enterprise name

budget_idstring required

The unique identifier of the budget

Request body

budget_amountinteger

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

prevent_further_usageboolean

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

budget_scope'enterprise' | 'organization' | 'repository' | 'cost_center' | 'multi_user_customer' | 'multi_user_cost_center' | 'user'

The scope of the budget.

  • enterprise: Apply the budget to the entire enterprise.
  • organization: Apply the budget to a specific organization in the enterprise.
  • repository: Apply the budget to a specific repository.
  • cost_center: Apply the budget to a specific cost center.
  • multi_user_customer: Apply a universal budget to all users in the enterprise.
  • multi_user_cost_center: Apply a universal budget to all users in a cost center.
  • user: Apply the budget to a single user.
budget_entity_namestring

The name of the entity to apply the budget to

budget_product_skustring

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

userstring

The username of the user for user scope budgets.

Response

Budget updated successfully

messagestring required

A message indicating the result of the update operation

Example response

{
  "budget": {
    "budget_scope": "enterprise",
    "budget_entity_name": "example-repository-name",
    "user": "octocat",
    "consumed_amount": 42.5,
    "budget_amount": 100,
    "prevent_further_usage": true,
    "budget_product_sku": "actions_linux",
    "budget_alerting": {
      "will_alert": true,
      "alert_recipients": [
        "mona",
        "lisa"
      ]
    }
  }
}