Sign in
billing

Get all budgets for an organization

[!NOTE] This endpoint is in public preview and is subject to change.

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. Each page returns up to 10 budgets.

get/organizations/{org}/settings/billing/budgets

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Query parameters

pageinteger

The page number of the results to fetch.

per_pageinteger

The number of results per page (max 10).

scope'enterprise' | 'organization' | 'repository' | 'cost_center'

Filter budgets by scope type.

Response

Response when getting all budgets

has_next_pageboolean

Indicates if there are more pages of results available (maps to hasNextPage from billing platform)

total_countinteger

Total number of budgets matching the query

Example response

{
  "budgets": [
    {
      "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
      "prevent_further_usage": true,
      "budget_scope": "enterprise",
      "budget_entity_name": "octocat/hello-world",
      "budget_alerting": {
        "will_alert": true,
        "alert_recipients": [
          "mona",
          "lisa"
        ]
      }
    }
  ]
}

Changes