---
title: "Get Workspace Credit Summary"
method: GET
path: "/api/workspace/credit-summary"
tags: ["sequences"]
---

# Get Workspace Credit Summary

`GET /api/workspace/credit-summary`

## Request

- Base URL: `https://platform.verbiflow.com/api/bridge`
- URL: `https://platform.verbiflow.com/api/bridge/api/workspace/credit-summary`
- Auth: one of:
  - HTTP bearer and API key in header `x-flage-org-id`
  - HTTP bearer and API key in header `x-flage-org-slug`

## Response `200`

Successful Response

- WorkspaceCreditSummaryPayload: One observational credit view shared by every product surface. Capacity thresholds never authorize or deny Play or SDK execution.
  - `base_credits_limit` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `billing_state` 'known' | 'needs_reconciliation', required: Whether the Stripe billing period is authoritative. needs_reconciliation uses a provisional calendar-month period for continued execution.
  - `breakdown` WorkspaceCreditBreakdownPayload, required: Credit ownership totals for the current workspace billing period.
    - `enrichment_consumed` string, required: Exact non-negative credit quantity in canonical decimal notation.
    - `enrichment_reserved` string, required: Exact non-negative credit quantity in canonical decimal notation.
    - `growth_observed` string, required: Exact non-negative credit quantity in canonical decimal notation.
    - `purchased_allocations` string, required: Exact non-negative credit quantity in canonical decimal notation.
    - `source_consumed` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `credit_overage_mode` 'metered' | 'blocked', required: Whether work above included capacity remains metered or is blocked.
  - `credits_available` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `credits_consumed` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `credits_limit` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `credits_reserved` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `credits_used` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `hard_credits_available` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `hard_credits_limit` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `included_overage_credits` string, required: Exact non-negative credit quantity in canonical decimal notation.
  - `is_hard_limit_reached` boolean, required: Whether no credit capacity remains before the workspace hard ceiling.
  - `is_over_included_limit` boolean, required: Whether consumed plus reserved credits exceed included and purchased capacity.
  - `purchased_credits` string, required: Exact non-negative credit quantity in canonical decimal notation.

---

[API](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract.md) - [All operations](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract/llms.txt) - [OpenAPI document](https://skmtc.dev/verbiflow/apis/verbiflow-sdk-http-contract/revisions/c80e903ef8f3?raw)