> ## Documentation Index
> Fetch the complete documentation index at: https://docs.macroscope.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get billing status

> Subscription standing, billing access, and billing model for a workspace.

Returns the workspace's subscription standing and billing-access state. Does not include balances or usage. Values can lag recent changes.

## Authorization

Requires workspace Read; Admin and Productivity are not required. No query parameters or pagination are supported. This status-only read does not expose balances, spending or detailed usage.

**Authorization** `string` *required*

`Bearer <key>`. See [Authentication](https://docs.macroscope.com/api#authentication).

## Path parameters

**workspaceType** `string` *required*

`GITHUB_ORGANIZATION` or `GITHUB_USER`.

**workspaceId** `string` *required*

Numeric GitHub ID of the organization or user.

## Response

**status** `string`

Subscription standing: `active`, `canceled`, `incomplete`, `incomplete_expired`, `past_due`, `paused`, `trialing`, `unpaid`, or `pending`. Tolerate new values.

**access** `string`

Billing-access state: `ok`, `exceeded`, `blocked`, `waived`, `overuse`, `spend_limit`, or `pending`. Omitted when unknown. Separate from `status`; do not infer one from the other.

**subscriptionType** `string`

Billing model: `monthly` (seat-based), `annual` (annual prepaid), or `credit` (credit-based). Not the invoice schedule. Omitted when unknown.

**periodEnd** `string`

End of the current billing period (RFC 3339, UTC). `1970-01-01T00:00:00Z` when no period end exists. Does not imply cancellation or renewal.

**postpaidBillingEnabled** `boolean`

`true` when the workspace is invoiced at period end without credit balance enforcement. Omitted when `false`.

```bash cURL theme={null}
curl https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/status \
  -H "Authorization: Bearer $MACROSCOPE_API_KEY"
```

```python Python theme={null}
import os, requests

r = requests.get(
    "https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/status",
    headers={"Authorization": f"Bearer {os.environ['MACROSCOPE_API_KEY']}"},
)
print(r.json())
```

```javascript JavaScript theme={null}
const res = await fetch(
  "https://api.macroscope.com/api/v1/workspaces/GITHUB_ORGANIZATION/12345678/billing/status",
  { headers: { Authorization: `Bearer ${process.env.MACROSCOPE_API_KEY}` } }
);
console.log(await res.json());
```

```json 200 theme={null}
{
  "status": "active",
  "periodEnd": "2026-10-01T00:00:00Z",
  "access": "ok",
  "subscriptionType": "credit"
}
```

```json 401 theme={null}
{ "code": 16, "message": "unauthenticated" }
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.