GitHub: Create a budget for an organization

← Billing operations · Get started

Operation github.billing_create_organization_budget

Provider route: POST /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"]["billingCreateOrganizationBudget"]>[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.billingCreateOrganizationBudget(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_create_organization_budget(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
body	object	Optional
body.budget_alerting	object	Optional
body.budget_alerting.alert_recipients	array	Optional	Array of user login names who will receive alerts. Rejected for user-scope 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. Rejected for user-scope 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.budget_entity_name	string	Optional	The entity to apply the budget to. The expected value depends on `budget_scope`. - `repository`: The repository name, or `owner/repo`. - `organization`, `multi_user_customer`, and `user`: Not used. For `user`, set the `user` field instead. Default:
body.budget_product_sku	string	Optional	A single product or SKU that will be covered in the budget
body.budget_scope	string	Optional	The scope of the budget for this organization. - `organization`: Apply the budget to the organization. - `repository`: Apply the budget to a specific repository in the organization. - `multi_user_customer`: Apply a universal budget to all users in the organization. - `user`: Apply the budget to a single user in the organization. `user` and `multi_user_customer` scopes are only supported when `budget_product_sku` is `ai_credits` or `premium_requests`. One of: organization, repository, multi_user_customer, user
body.budget_type	JSON	Optional	The type of pricing model used by the budget. Determines how `budget_product_sku` is interpreted. - `BundlePricing`: Covers all AI credit SKUs. Set `budget_product_sku` to `ai_credits`. - `ProductPricing`: Covers all SKUs that belong to a product. Set `budget_product_sku` to a product such as `actions` or `packages`. - `SkuPricing`: Covers a single, specific SKU. Set `budget_product_sku` to a SKU such as `actions_linux`.
body.budget_type (oneOf 1)	string	Alternative	One of: BundlePricing
body.budget_type (oneOf 2)	string	Alternative	One of: ProductPricing
body.budget_type (oneOf 3)	string	Alternative	One of: SkuPricing
body.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
body.prevent_further_usage	boolean	Optional	Whether to prevent additional spending once the budget is exceeded. For `user` and `multi_user_customer` scopes, this must be `true`.
body.user	string	Optional	The username of the user for `user` scope budgets. This field is required when `budget_scope` is `user`.

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

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

Schemas

Create 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. Rejected 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. Rejected 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.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
message	string	Required within parent	A message indicating the result of the create operation

Policy, approvals and errors

SDK function policy ID: github.billing_create_organization_budget. Catalog operation: billing/create-organization-budget. 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