GitHub: Update a budget for an organization

GitHub billing.billingUpdateBudgetOrg: arguments, response, policy and SDK examples.

Operation github.billing_update_budget_org

Provider route: PATCH /organizations/{org}/settings/billing/budgets/{budget_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["billing"]["billingUpdateBudgetOrg"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.billing.billingUpdateBudgetOrg(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.billing.billing_update_budget_org(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.org`	string	Required within parent
`path.budget_id`	string	Required within parent
`body`	object	Required within parent
`body.budget_alerting`	object	Optional
`body.budget_alerting.alert_recipients`	array	Optional	Array of user login names who will receive alerts. Ignored for user-scopes as alerting is always disabled for them.
`body.budget_alerting.alert_recipients[]`	string	Each item
`body.budget_alerting.will_alert`	boolean	Optional	Whether alerts are enabled for this budget. Ignored for user-scopes as alerting is always disabled for them.
`body.budget_amount`	integer	Optional	The budget amount in whole dollars. For license-based products, this represents the number of licenses.
`body.expires_at`	JSON	Optional	The date the budget will expire in `YYYY-MM-DD` format. Only dates in the future are accepted. If not set, the budget will not expire. Setting to `null` or `0` will remove the expiration date from a budget if set. Only supported for existing user-scoped budgets.
`body.expires_at (oneOf 1)`	JSON	Alternative
`body.expires_at (oneOf 1) (anyOf 1)`	string	Alternative	Format: date
`body.expires_at (oneOf 1) (anyOf 2)`	null	Alternative
`body.expires_at (oneOf 2)`	integer	Alternative	One of: 0
`body.prevent_further_usage`	boolean	Optional	Whether to prevent additional spending once the budget is exceeded. For budgets with `user` or `multi_user_customer` scope, this must remain `true`.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Update a budget for an organization — response body

Referenced models: Update a budget for an organization — response body

Schemas

Update a budget for an organization — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`budget`	object	Required within parent
`budget.budget_alerting`	object	Optional
`budget.budget_alerting.alert_recipients`	array	Optional	Array of user login names who will receive alerts. Ignored for user-scope as alerting is always disabled for them.
`budget.budget_alerting.alert_recipients[]`	string	Each item
`budget.budget_alerting.will_alert`	boolean	Optional	Whether alerts are enabled for this budget. Ignored for user-scope as alerting is always disabled for them.
`budget.budget_amount`	JSON	Optional
`budget.budget_amount (anyOf 1)`	integer	Alternative	The budget amount in whole dollars. For license-based products, this represents the number of licenses. Minimum: 0
`budget.budget_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`budget.budget_entity_name`	string	Optional	The name of the entity to apply the budget to
`budget.budget_product_sku`	string	Optional	A single product or sku to apply the budget to.
`budget.budget_scope`	string	Optional	The type of scope for the budget Known values: enterprise, organization, repository, cost_center, multi_user_customer, multi_user_cost_center, user
`budget.budget_type`	JSON	Optional	The type of pricing for the budget
`budget.budget_type (anyOf 1)`	string	Alternative	Known values: ProductPricing
`budget.budget_type (anyOf 2)`	string	Alternative	Known values: SkuPricing
`budget.consumed_amount`	JSON	Optional
`budget.consumed_amount (anyOf 1)`	number	Alternative	The consumed amount for the specified user within the budget. Only included for `user`-scoped budgets.
`budget.consumed_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`budget.expires_at`	string	Optional	The date the budget will expire in `YYYY-MM-DD` format. Only dates in the future are accepted. If not provided, the budget will not expire. Only supported for budgets with `budget_scope` of `user` Format: date
`budget.id`	string	Optional	ID of the budget.
`budget.prevent_further_usage`	boolean	Optional	Whether to prevent additional spending once the budget is exceeded
`budget.user`	string	Optional	The user login when the budget is scoped to a single user (`user` scope).
`message`	string	Required within parent	A message indicating the result of the update operation

Policy, approvals and errors

SDK function policy ID: github.billing_update_budget_org. Catalog operation: billing/update-budget-org. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page