billing
Get all budgets for an organization
Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. Each page returns up to 100 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 100).
scope'enterprise' | 'organization' | 'repository' | 'cost_center' | 'multi_user_customer' | 'user'
Filter budgets by scope type.
- organization: Budgets scoped to the organization.
- repository: Budgets scoped to a repository.
- multi_user_customer: Universal budgets that apply to all users in the organization.
- user: Budgets scoped to an individual user.
userstring
Filter consumed amount details for budgets by the specified user login.
Response
Response when getting all budgets
Example response
{
"budgets": [
{
"id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
"prevent_further_usage": true,
"budget_scope": "enterprise",
"budget_entity_name": "octocat/hello-world",
"user": "octocat",
"budget_alerting": {
"will_alert": true,
"alert_recipients": [
"mona",
"lisa"
]
}
}
]
}