billing

Update a budget for an organization

Changed on

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

patch/organizations/{org}/settings/billing/budgets/{budget_id}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/organizations/{org}/settings/billing/budgets/{budget_id}
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

budget_idstring required

The ID corresponding to 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.

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"
      ]
    },
    "expires_at": "2026-12-31"
  }
}

Changes

  • 2026-03-10a32e25bd4f21Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

  • 2026-03-1077bd502d6220Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status