Get credit usage
get_credit_usageCompany spend snapshot in one read: remaining FOS credits vs plan limit, reset date, named $ cap when set, Grok mix on the FOS ledger (optional Grok Bot / Grok Build when those hosts are attributed), and hosting from the books as this calendar month (hosting.this_month_usd + hosting.month YYYY-MM; zeros when empty). period (today/week/month/all) filters FOS credits and usage only — hosting is always the current calendar month from finance_data CASH OUT rows, not the period arg. On a developer-account pool, also returns true inference $ (true_cost_usd / true_cost_remaining_usd). Use when checking remaining credits, burn vs cap, or Grok mix.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Time period for FOS credit/usage breakdown only. Does not change hosting (always this calendar month). Default: "month" | |
| companyId | Yes | FreedomOS company id to act within (you must be a member). Required for company-scoped tools. | |
| breakdown_by | No | How to group the usage data. Default: "both" |