Get usage

GET/v1/login/boo-admin/usage

Boo's use in a billing period, by person, account, group, model or cloud service, with the organization's total, its plan's credits and its bought credits. Until your organization has its first billing period, this answers 404 with not_found.

Permission: boo-admin:GetUsage

Query parameters

Name
group_by person (the default), account, group, model or cloud
period_id a billing period; the current one if left out
account_id only this account's use
person_id only this person's use
page_size rows per page, 1 to 100 (50 if left out)
after the next_after of the page before

A group's use is its members'; someone in two groups counts in both. Amounts are micros, millionths of a credit, as strings: "25000000" is 25 credits. settled_micros is what has been charged; committed_micros adds work still running. settled_cost_micros is what those credits cost you, when it is known.

Returns

200 OK

{
  "balance": {
    "credited_micros": "500000000",
    "committed_micros": "12500000",
    "available_micros": "487500000",
    "prepaid_available_micros": "387500000",
    "included_available_micros": "100000000",
    "expired_micros": "0",
    "financial_hold": false
  },
  "period": {
    "id": "5d2e8c71-9a4b-4e3f-8c1d-2b6a7f0e9d34",
    "starts_at": "2026-11-01T00:00:00Z",
    "ends_at": "2026-12-01T00:00:00Z"
  },
  "totals": {
    "settled_micros": "41000000",
    "held_micros": "2500000",
    "committed_micros": "43500000",
    "settled_cost_micros": "41000000",
    "committed_cost_micros": "43500000"
  },
  "rows": [
    {
      "key": "8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10",
      "name": "",
      "totals": {
        "settled_micros": "41000000",
        "held_micros": "2500000",
        "committed_micros": "43500000",
        "settled_cost_micros": "41000000",
        "committed_cost_micros": "43500000"
      }
    }
  ],
  "next_after": "",
  "as_of": "2026-11-20T10:12:00Z",
  "plan_credits": { "granted_micros": "100000000", "used_micros": "41000000" },
  "credits": {
    "beginning_micros": "400000000",
    "added_micros": "0",
    "used_micros": "12500000",
    "available_micros": "387500000"
  }
}

A row's key is what it is grouped by: a person's ID, an account's ID, a group's ID, a model's ID (with its name) or a cloud service.

Example

curl "https://<company>.yotta.bot/v1/login/boo-admin/usage?group_by=account" \
  -H "Authorization: Bearer $YOTTABOT_TOKEN"

With yottactl

yottactl org boo usage --query group_by=account