Get a person's allowance

GET/v1/login/boo-admin/allowances/{person}

What one person may use this period: their plan's credits and any extra credits, what they have committed, and what is left. Their plan is their own, else their groups' highest, else the organization's default. Until your organization has its first billing period, this answers 404 with not_found.

Permission: boo-admin:GetUsage

Path parameters

Name
person the person's ID

Query parameters

Name
period_id a billing period; the current one if left out

Returns

200 OK

{
  "period": {
    "id": "5d2e8c71-9a4b-4e3f-8c1d-2b6a7f0e9d34",
    "starts_at": "2026-11-01T00:00:00Z",
    "ends_at": "2026-12-01T00:00:00Z"
  },
  "limit": { "micros": "100000000" },
  "committed_micros": "43500000",
  "remaining_micros": "56500000",
  "policy_revision": "4",
  "extra_left_micros": "0"
}

Amounts are micros, millionths of a credit, as strings: "25000000" is 25 credits.

Errors

  • 404 subject_not_found: no one in your organization has that ID.

Example

curl "https://<company>.yotta.bot/v1/login/boo-admin/allowances/8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10" \
  -H "Authorization: Bearer $YOTTABOT_TOKEN"

With yottactl

yottactl org boo allowance 8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10