Get costManagementUserBalance

Important

APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.

Retrieve a user's computed consumption balance, represented by a costManagementUserBalance object. Expand serviceBalances to inline the per-service rows. If the upstream evaluator fails for every service, the method returns a 503 sourceUnavailable response.

Note

The parent collection GET /copilot/costManagement/userBalances is declared but isn't listable and returns a 404 response. Read a balance by the user's identifier instead.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	CopilotCostManagement-UserData.Read.All	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

GET /copilot/costManagement/userBalances/{userId}

Optional query parameters

This method supports the $expand (on serviceBalances) and $select OData query parameters to help customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a costManagementUserBalance object in the response body.

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/copilot/costManagement/userBalances/aa110000-0000-0000-0000-000000000000?$expand=serviceBalances

Response

The following example shows the response. The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#copilot/costManagement/userBalances(serviceBalances())/$entity",
  "id": "aa110000-0000-0000-0000-000000000000",
  "serviceBalances": [
    {
      "serviceId": "workIQ",
      "spendingPolicyId": "3f9e2c1a-0000-0000-0000-00000000c21b",
      "configuredPeriodLimit": { "@odata.type": "#microsoft.graph.limitedCostManagementQuantity", "value": 10000, "unit": "copilotCredit" },
      "configuredPerUserLimit": { "@odata.type": "#microsoft.graph.limitedCostManagementQuantity", "value": 500, "unit": "copilotCredit" },
      "effectiveCapacityQuantity": { "@odata.type": "#microsoft.graph.limitedCostManagementQuantity", "value": 0, "unit": "copilotCredit" },
      "consumedQuantity": 180,
      "remainingQuantity": { "@odata.type": "#microsoft.graph.limitedCostManagementQuantity", "value": 0, "unit": "copilotCredit" },
      "unit": "copilotCredit",
      "isConsumptionAllowed": false,
      "accessDecisionReason": "limitExhausted",
      "dataStatus": {
        "lastModifiedDateTime": "2026-07-27T09:15:00Z"
      }
    }
  ],
  "unevaluatedServices": [],
  "selectionDataStatus": {
    "evaluatedDateTime": "2026-07-27T09:20:00Z",
    "policyConfigurationAsOfDateTime": "2026-07-27T09:18:00Z",
    "groupMembershipAsOfDateTime": "2026-07-27T08:45:00Z",
    "usageAsOfDateTime": "2026-07-27T09:15:00Z"
  }
}