billing

Get user states for a multi-user budget

Changed on

Lists per-user budget state for a multi-user customer scoped budget. Enterprise owners and billing managers can view state across the enterprise, and organization administrators can view state for budgets scoped to organizations they administer. A custom role holder with fine-grained read access to enterprise billing can also view budget user states. An installation access token for a GitHub App installed on the enterprise with read access to enterprise billing can list user states for any multi-user budget in the enterprise.

get/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states

Request

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

Path parameters

enterprisestring required

The slug version of the enterprise name.

budget_idstring required

The ID corresponding to the budget.

Query parameters

pageinteger

The page number of results to fetch.

per_pageinteger

The number of results per page.

sort_order'0' | '1'

Sort order for results. 0 for descending, 1 for ascending.

userstring

Filter user states to a specific user login.

threshold_lower_boundinteger

Filter user states whose threshold percentage is at or above this value. This filter is calculated using each user's consumption against the universal budget amount, even when the user has a user-scoped budget override.

threshold_upper_boundinteger

Filter user states whose threshold percentage is at or below this value. This filter is calculated using each user's consumption against the universal budget amount, even when the user has a user-scoped budget override.

Response

Response when getting per-user states for a multi-user budget

has_next_pageboolean required

Indicates if there are more pages of results available.

total_countinteger required

Total number of user state entries matching the query.

Changes