---
title: "Get Billing Account"
method: GET
path: "/api/v1/internal/workspaces/{workspace_id}/billing-account"
tags: ["internal", "workspaces"]
---

# Get Billing Account

`GET /api/v1/internal/workspaces/{workspace_id}/billing-account`

## Path parameters

- `workspace_id` string, uuid, required

## Response `200`

Successful Response

- BillingAccountResponse — One workspace's billing account, as the internal console reads it. Carries the domain's own free/paid verdict rather than leaving the console to rebuild it from ``plan_key``: the plan's spelling is a value the client shares no symbol with, so a console that compares the string is a consumer a rename cannot reach.
  - `workspace_id` string, uuid, required
  - `plan_key` string, required
  - `plan_version` string, required
  - `on_free_plan` boolean, required
  - `status` 'pending' | 'active' | 'past_due' | 'unpaid' | 'cancelled', required — Subscription state as MAIA understands it, not as Stripe reports it. ``PAST_DUE`` is the retry window: full access with a visible warning. ``UNPAID`` is that window exhausted — paid work refuses until payment succeeds, but the subscription has not ended, so purchased usage is kept. ``CANCELLED`` is paid access ended. Purchased usage is kept there too — no status takes it — but only a status that keeps paid access may spend it.
  - `anchor_day` integer, required
  - `period_start` string, date, required
  - `period_end` string, date, required
  - `included_granted_usd` string, required
  - `included_consumed_usd` string, required
  - `purchased_balance_usd` string, required
  - `given_balance_usd` string, required — The part of purchased_balance_usd staff gave for free.
  - `activated_at` string, date-time, nullable, required

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-19** `8fb358001d37` — 1 info
  - added the required property `given_balance_usd` to the response with the `200` status
- **2026-09-15** `499d0b94aa94` — 1 info
  - added the required property `on_free_plan` to the response with the `200` status
- **2026-09-12** `604ea84d0ff7` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/maia-analytics/apis/maia-api/changes/api/v1/internal/workspaces/:workspace_id/billing-account/get.md)

---

[API](https://skmtc.dev/maia-analytics/apis/maia-api.md) · [All operations](https://skmtc.dev/maia-analytics/apis/maia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/maia-analytics/apis/maia-api/revisions/bb508e935174?raw)