GitHub: Get a budget by ID for an organization

← Billing operations · Get started

Operation github.billing_get_budget_org

Provider route: GET /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"]["billingGetBudgetOrg"]>[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.billingGetBudgetOrg(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_get_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

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 Get a budget by ID for an organization — response body

Referenced models: Get a budget by ID for an organization — response body

Schemas

Get a budget by ID for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
budget_alerting	object	Required within parent
budget_alerting.alert_recipients	array	Optional	Array of user login names who will receive alerts. Present but not applicable for user-scope as alerting is always disabled for them.
budget_alerting.alert_recipients[]	string	Each item
budget_alerting.will_alert	boolean	Optional	Whether alerts are enabled for this budget. Present but not applicable for user-scope as alerting is always disabled for them.
budget_amount	JSON	Required within parent
budget_amount (anyOf 1)	integer	Alternative	The budget amount in whole dollars. For license-based products, this represents the number of licenses.
budget_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
budget_entity_name	string	Required within parent	The name of the entity to apply the budget to
budget_product_sku	string	Required within parent	A single product or sku to apply the budget to.
budget_scope	string	Required within parent	The type of scope for the budget Known values: enterprise, organization, repository, cost_center, multi_user_customer, multi_user_cost_center, user
budget_type	JSON	Required within parent	The type of pricing for the budget
budget_type (anyOf 1)	string	Alternative	Known values: ProductPricing
budget_type (anyOf 2)	string	Alternative	Known values: SkuPricing
consumed_amount	JSON	Optional
consumed_amount (anyOf 1)	number	Alternative	The current usage amount counted toward the budget. How usage is calculated may vary by budget type.
consumed_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	ID of the budget.
prevent_further_usage	boolean	Required within parent	Whether to prevent additional spending once the budget is exceeded
user	string	Optional	The user login when the budget is scoped to a single user (`user` scope).

Policy, approvals and errors

SDK function policy ID: github.billing_get_budget_org. Catalog operation: billing/get-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