Budgets

Verwenden Sie die REST-API, um Budgetinformationen abzurufen.

Wichtig

Das unten aufgeführte Anforderungstextschema fehlt ein erforderliches Feld. Wenn budget_scope``user ist, müssen Sie auch ein Feld user angeben, das auf den GitHub Benutzernamen festgelegt ist, für den das Budget gilt. Wenn Sie dieses Feld weglassen, gibt die API zurück HTTP 400: Missing required fields: budget_entity_name. Bei benutzerbezogenen Budgets kann budget_entity_name eine leere Zeichenfolge sein.

Im folgenden Beispiel wird ein benutzerbezogenes Budget erstellt, das den monatlichen Wert CopilotAI credits eines einzelnen Benutzers auf 30 USD beschränkt:

{
  "budget_amount": 30,
  "prevent_further_usage": true,
  "budget_scope": "user",
  "budget_entity_name": "",
  "budget_type": "BundlePricing",
  "budget_product_sku": "ai_credits",
  "budget_alerting": {
    "will_alert": false,
    "alert_recipients": []
  },
  "user": "USERNAME"
}

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.

Feinkörnige Zugriffstoken für "Get all budgets for an organization"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss über den folgenden Berechtigungssatz verfügen.:

  • "Administration" organization permissions (read)

Parameter für "Get all budgets for an organization"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
org string Erforderlich

The organization name. The name is not case sensitive.

Abfrageparameter
page integer

The page number of the results to fetch.

Standard: 1

per_page integer

The number of results per page (max 100).

Standard: 10