GitHub: Get all budgets for an organization

← Billing operations · Get started

Operation github.billing_get_all_budgets_org

Provider route: GET /organizations/{org}/settings/billing/budgets. 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"]["billingGetAllBudgetsOrg"]>[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.billingGetAllBudgetsOrg(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_all_budgets_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
query	object	Optional	Additional keys: not allowed
query.page	integer	Optional	Default: 1
query.per_page	integer	Optional	Default: 10
query.scope	string	Optional	One of: enterprise, organization, repository, cost_center, multi_user_customer, user
query.user	string	Optional

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 all budgets for an organization — response body

Referenced models: Get all budgets for an organization — response body

Schemas

Get all budgets for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
budgets	array	Required within parent	Array of budget objects for the enterprise
budgets[]	Model	Each item	Expand Get all budgets for an organization — response body — budgets item
effective_budget	object	Optional	Effective user-level budget details returned when the response is scoped with the `user` query parameter.
effective_budget.budget_amount	JSON	Required within parent
effective_budget.budget_amount (anyOf 1)	integer	Alternative	The budget amount for the effective budget.
effective_budget.budget_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effective_budget.consumed_amount	JSON	Required within parent
effective_budget.consumed_amount (anyOf 1)	number	Alternative	The consumed amount for the specified user within the effective budget.
effective_budget.consumed_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effective_budget.id	string	Required within parent	The unique identifier of the effective budget.
has_next_page	boolean	Optional	Indicates if there are more pages of results available
total_count	JSON	Optional
total_count (anyOf 1)	integer	Alternative	Total number of budgets matching the query
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
user	string	Optional	User login included when the response is scoped with the `user` query parameter.

Referenced models: Get all budgets for an organization — response body — budgets item

Get all budgets for an organization — response body — budgets item

Field	Type	Presence	Description and constraints
$	object	Root
budget_alerting	object	Required within parent
budget_alerting.alert_recipients	array	Required within parent	Array of user login names who will receive alerts. Ignored for user-scope as alerting is disabled for them.
budget_alerting.alert_recipients[]	string	Each item
budget_alerting.will_alert	boolean	Required within parent	Whether alerts are enabled for this budget. Ignored for user-scope as alerting is disabled for them.
budget_amount	JSON	Required within parent
budget_amount (anyOf 1)	integer	Alternative	The budget amount limit 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	Optional	The name of the entity for the budget (enterprise does not require a name).
budget_product_sku	string	Required within parent	A single product or sku to apply the budget to.
budget_scope	string	Required within parent	The scope of 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: SkuPricing
budget_type (anyOf 2)	string	Alternative	Known values: ProductPricing
consumed_amount	JSON	Optional
consumed_amount (anyOf 1)	number	Alternative	The amount consumed for a user-scoped budget, or for a multi-user budget when filtering by user.
consumed_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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
id	string	Required within parent	The unique identifier for the budget
prevent_further_usage	boolean	Required within parent	The type of limit enforcement for the budget
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_all_budgets_org. Catalog operation: billing/get-all-budgets-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