billing

Get a budget by ID

Changed on

Gets a budget by ID. Enterprise owners and billing managers can view any budget in the enterprise, and organization administrators can view budgets scoped to organizations and repositories they administer. A custom role holder with fine-grained read access to enterprise billing can view the budget unless it is scoped to a repository; repository-scoped budgets require the organization administrator permissions described above. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can get any budget in the enterprise.

get/enterprises/{enterprise}/settings/billing/budgets/{budget_id}

Request

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

Path parameters

enterprisestring required

The slug version of the enterprise name.

budget_idstring required

The ID corresponding to the budget.

Response

Response when updating a budget

idstring required

ID of the budget.

budget_scope'enterprise' | 'organization' | 'repository' | 'cost_center' | 'multi_user_customer' | 'multi_user_cost_center' | 'user' required

The type of scope for the budget

budget_entity_namestring required

The name of the entity to apply the budget to

userstring

The user login when the budget is scoped to a single user (user scope).

budget_amountinteger required

The budget amount in whole dollars. For license-based products, this represents the number of licenses.

prevent_further_usageboolean required

Whether to prevent additional spending once the budget is exceeded

budget_product_skustring required

A single product or sku to apply the budget to.

consumed_amountnumber

The current usage amount counted toward the budget. How usage is calculated may vary by budget type.

Example response

{
  "budget_scope": "enterprise",
  "budget_entity_name": "octocat/hello-world",
  "user": "octocat",
  "prevent_further_usage": true,
  "budget_product_sku": "actions_linux",
  "budget_alerting": {
    "will_alert": true,
    "alert_recipients": [
      "mona",
      "lisa"
    ]
  },
  "consumed_amount": 12.5
}

Changes

  • 2022-11-28d47f98f3168aRevision changes
    • info

      added the optional property to the response with the status

  • 2022-11-28ff40e51c67d0Revision changes
    • warning

      added the new multi_user_cost_center enum value to the response property for the response status