---
title: "Read exact execution-credit state"
method: GET
path: "/v1/billing/summary"
---

# Read exact execution-credit state

`GET /v1/billing/summary`

## Request

- Base URL: `https://docs.greatwait.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.greatwait.dev/v1/billing/summary`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `Greatwait-Environment` and API key in header `Greatwait-Project`

Reads the verified principal's organization-wide prepaid execution position from the authoritative PostgreSQL ledger. Desired and effective revisions remain distinct, and pending stays true until the control plane records PostgreSQL confirmation. Amounts are exact integer microdollars encoded as decimal strings; currency is USD and scale is six. Reserved credit has already been committed to a logical attempt but is not yet a settled debit. A missing hard cap means the customer elected no execution spending cap, never zero room. Shadow mode records what enforcement would have done without charging or blocking, and the activation boundary prevents retroactive charges.

## Response `200`

Read exact execution-credit state

- object
  - `activation` object, required
    - `boundary` string, required
    - `mode` 'disabled' | 'shadow' | 'enforced', required
  - `blockingReasons` string[], required
  - `budgetPolicy` object, required
    - `desired` object, required
      - `advisoryBudget` object, nullable, required
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
      - `hardCap` object, nullable, required
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
    - `desiredRevision` integer, required
    - `effectiveRevision` integer, required
    - `pending` boolean, required
  - `closedAt` string
  - `credit` object, required
    - `available` object, required
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `consumed` object, required
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `reserved` object, required
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `byKind` object
      - `purchased` object, required
        - `available` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `reserved` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `consumed` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `forfeited` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `granted` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `expiresAt` string
      - `trial` object, required
        - `available` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `reserved` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `consumed` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `forfeited` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `granted` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `expiresAt` string
      - `promotional` object, required
        - `available` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `reserved` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `consumed` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `forfeited` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `granted` object, required
          - `currency` 'USD', required
          - `microdollars` string, required
          - `scale` 6, required
        - `expiresAt` string
  - `desiredRevision` integer, required
  - `effectiveRevision` integer, required
  - `freshness` object, required
    - `kind` 'authoritative', required
  - `includedProject` string
  - `period` object
    - `advisoryBudget` object
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `hardCap` object
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `remainingToHardCap` object
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `advisoryBudgetProgress` object
      - `committed` object, required
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
      - `remaining` object, required
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
    - `automaticExecutionTopUp` object, required
      - `cap` object
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
      - `pending` object, required
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
      - `remainingToCap` object
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
      - `settled` object, required
        - `currency` 'USD', required
        - `microdollars` string, required
        - `scale` 6, required
    - `subscribedProjectFees` object, required
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `reservedUsage` object, required
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `settledUsage` object, required
      - `currency` 'USD', required
      - `microdollars` string, required
      - `scale` 6, required
    - `start` string, required
    - `end` string, required
  - `pending` boolean, required
  - `priceVersion` string, required
  - `trialExpiresAt` string

## Other responses

- `401`: Problem document. Possible codes at this status: authentication_required, credential_expired, credential_revoked.
- `403`: Problem document. Possible codes at this status: scope_missing.
- `409`: Problem document. Possible codes at this status: project_archived.
- `429`: Problem document. Possible codes at this status: rate_limited.
- `503`: Problem document. Possible codes at this status: billing_not_ready, capability_not_configured, service_unavailable.

---

[API](https://skmtc.dev/greatwait/apis/greatwait-v1.md) · [All operations](https://skmtc.dev/greatwait/apis/greatwait-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/greatwait/apis/greatwait-v1/revisions/6855bce23e72?raw)