> ## Documentation Index > Fetch the complete documentation index at: https://streamloop.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get the billing account > The workspace's billing account: balance, credit limit and headroom (balance + creditLimit, plus up to half the limit again on an open credit line), spend cap, standing, the burn of usage no plan covers, the catalog version it is priced on, its default card, auto top-up, period cost by subject and its plan (lines, totals, renewal). Money is micro-USD: $1 = 1000000. ## OpenAPI ````yaml https://api.streamloop.app/v1/openapi.json get /billing/account openapi: 3.1.0 info: contact: name: Streamloop url: https://streamloop.app description: >- The Streamloop REST API. Authenticate with either an `X-API-Key` header (a Streamloop API key, prefix `sl_` — simplest for programmatic clients) or an OAuth 2.1 bearer access token (obtain one via https://auth.streamloop.app). With an API key, name the workspace in `X-Workspace-Id` (GET /workspaces lists yours). Collections are cursor-paginated (`limit` + `cursor`, returning `{ data, page }`). Errors are RFC 7807 problem documents. summary: >- Programmatic access to Streamloop — create and control 24/7 loop streams, manage media, destinations, playlists, and billing. title: Streamloop API version: 1.0.0 servers: - description: Production url: https://api.streamloop.app/v1 security: - oauth2: [] - bearerAuth: [] - apiKey: [] tags: - description: The authenticated user's account and workspaces. name: account - description: >- The billing account, price catalog and quotes, plans, top-ups, cards and spend cap; usage analytics and invoices. name: billing - description: Crypto deposit options for topping up credits. name: crypto - description: Manage streaming destinations (custom RTMP). name: destinations - description: Service metadata, discovery documents, and batch execution. name: meta - description: 'Stream and scene playlists: list, create, edit and publish.' name: playlists - description: >- Create, control, schedule, and monitor 24/7 streams: their destinations and scene. name: streams - description: Upload and manage source media (video/audio). name: uploads paths: /billing/account: get: tags: - billing summary: Get the billing account description: >- The workspace's billing account: balance, credit limit and headroom (balance + creditLimit, plus up to half the limit again on an open credit line), spend cap, standing, the burn of usage no plan covers, the catalog version it is priced on, its default card, auto top-up, period cost by subject and its plan (lines, totals, renewal). Money is micro-USD: $1 = 1000000. operationId: billingAccount parameters: - description: >- Workspace this request operates in — the workspace id (`wksp_…`) or the organization id, from GET /workspaces. Required with an API key, which carries no workspace (400 `WORKSPACE_REQUIRED` without it). With an OAuth token it defaults to the workspace the token was issued for. Responds 403 `WORKSPACE_FORBIDDEN` when the caller is not a current member, rather than falling back to another workspace. in: header name: X-Workspace-Id required: false schema: type: string responses: '200': content: application/json: schema: anyOf: - $ref: '#/components/schemas/BillingAccount' - type: 'null' description: Successful response. headers: RateLimit: description: >- The same three as one structured field: limit=, remaining=, reset= (IETF RateLimit header fields draft). schema: type: string RateLimit-Limit: description: Requests allowed per window. schema: type: integer RateLimit-Policy: description: 'The quota and its window in seconds: 600;w=60.' schema: type: string RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window resets. schema: type: integer '400': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: 'No workspace selected: send X-Workspace-Id (WORKSPACE_REQUIRED).' '401': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: Missing or invalid access token. '403': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The token lacks the required scope or access to the resource. '404': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: The resource does not exist or is not visible to the caller. '422': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: >- The request is invalid, or refused for the resource as it is (the code says why). '429': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: Rate limit exceeded. Retry after the indicated delay. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer '502': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: Unexpected failure (UPSTREAM_ERROR). security: - oauth2: - streamloop:read - bearerAuth: [] - apiKey: [] components: schemas: BillingAccount: properties: billing: properties: autoTopUp: description: >- Recharges the balance from a saved card when it runs low; null = off. properties: amount: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer cardId: type: string threshold: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer required: - amount - cardId - threshold type: - object - 'null' balance: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer catalog: description: >- Which catalog prices pay-as-you-go usage; pinned for legacy workspaces. properties: isDefault: type: boolean version: type: string required: - isDefault - version type: object catalogVersionUntil: description: >- When the pin ends and pay-as-you-go moves to the default version (notice 60 days before). format: date-time type: - string - 'null' creditLimit: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer defaultCard: properties: brand: type: string expMonth: type: integer expYear: type: integer id: type: string isDefault: type: boolean last4: type: string rail: enum: - STRIPE - KEEPZ - OXPROCESSING type: string status: enum: - ACTIVE - EXPIRED - REMOVED type: string required: - brand - expMonth - expYear - id - isDefault - last4 - rail - status type: - object - 'null' headroom: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer id: type: string periodCost: description: This cycle's usage charges, split by subject. properties: other: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer since: format: date-time type: string subjects: items: properties: amount: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer covered: type: boolean subject: type: string required: - amount - covered - subject type: object type: array total: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer required: - other - since - subjects - total type: object plan: description: >- The account's current products as one invoice-shaped view (what the dashboard renders). properties: cancelAtPeriodEnd: type: boolean lines: items: properties: product: properties: key: type: string price: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer term: enum: - MONTHLY - YEARLY type: string required: - key - price - term type: object quantity: type: integer quantityAtRenewal: type: integer total: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer unitPrice: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer required: - product - quantity - quantityAtRenewal - total - unitPrice type: object type: array monthlyTotal: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer renewalTotal: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer renewsAt: format: date-time type: - string - 'null' status: enum: - TRIALING - ACTIVE - PAST_DUE - CANCELED type: string term: enum: - MONTHLY - YEARLY type: string trialEndsAt: format: date-time type: - string - 'null' required: - cancelAtPeriodEnd - lines - monthlyTotal - renewalTotal - status - term type: - object - 'null' spendCap: description: 'Micro-USD: $1 = 1000000.' format: int64 type: - integer - 'null' standing: description: >- PAUSED: loops outside the plan stopped when headroom reached 0, until a payment lifts it. enum: - OK - WARNING - PAUSED type: string subscriptionEngine: description: Chosen at first plan purchase. enum: - INTERNAL - STRIPE type: string uncoveredPerHour: description: 'Micro-USD: $1 = 1000000.' format: int64 type: integer required: - balance - catalog - creditLimit - headroom - id - periodCost - standing - subscriptionEngine - uncoveredPerHour type: object id: type: string required: - billing - id type: object Problem: additionalProperties: description: Details of the refusal beyond its code, e.g. reason. description: RFC 7807 problem-details error body. properties: code: description: >- A stable, machine-readable error code: branch on it, not on the HTTP status. 400: BAD_REQUEST, INVALID_BATCH, WORKSPACE_REQUIRED. 401: UNAUTHENTICATED. 402: CARD_DECLINED, INSUFFICIENT_CREDITS, INSUFFICIENT_FUNDS. 403: FORBIDDEN, INSUFFICIENT_SCOPE, MULTISTREAM_NOT_ENABLED. 404: NOT_FOUND. 405: METHOD_NOT_ALLOWED. 409: CONFLICT, DESTINATION_DUPLICATE, DESTINATION_LIMIT, IMMUTABLE_WHILE_LIVE, IN_USE, LAST_DESTINATION, MIRROR_DESTINATION_CHANGE_BLOCKED, NOT_LIVE, STALE_DRAFT, STREAM_ILLEGAL_TRANSITION, STREAM_LIVE, UPLOAD_ALREADY_COMPLETED, UPLOAD_INCOMPLETE, UPLOAD_NOT_LANDED, YOUTUBE_DESTINATION_LIMIT. 410: GONE. 422: DESTINATION_INCOMPATIBLE, FILE_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, INVALID_INPUT, SCENE_ASSET_MISSING, SCENE_MISSING, SCENE_NOT_PUBLISHED, SCENE_PLAYLISTS_UNSUPPORTED, SCENE_PLAYLIST_MISSING, SCENE_QUALITY_UNSUPPORTED, STREAM_GUARD_FAILED, UNSUPPORTED_TYPE, UPLOAD_REMOVED. 429: RATE_LIMITED. 500: INTERNAL. 502: UPSTREAM_ERROR. 503: EXTERNAL_UPLOAD_ENQUEUE_FAILED, UNAVAILABLE. Other codes: 404 for *_NOT_FOUND, 403 for *_FORBIDDEN, 503 for *_UNAVAILABLE, else 422. 502 UPSTREAM_ERROR is an unexpected failure. type: string detail: description: A human-readable explanation specific to this occurrence. type: string status: description: The HTTP status code. type: integer title: description: A short, human-readable summary of the problem. type: string type: description: A URI reference identifying the problem type. format: uri-reference type: string required: - type - title - status - detail - code type: object securitySchemes: oauth2: description: OAuth 2.1 authorization-code flow with PKCE. flows: authorizationCode: authorizationUrl: https://auth.streamloop.app/api/auth/oauth2/authorize scopes: streamloop:billing: >- Move money: top up, start, change or cancel a plan, set the spend cap streamloop:destructive: Delete streams and destinations streamloop:read: Read streams, destinations, playlists, and billing status streamloop:write: Create and control streams, destinations, and playlists tokenUrl: https://auth.streamloop.app/api/auth/oauth2/token type: oauth2 bearerAuth: bearerFormat: JWT description: An OAuth 2.1 bearer access token. scheme: bearer type: http apiKey: description: >- A Streamloop API key (prefix `sl_`), sent in the `X-API-Key` header. Create and manage keys in the dashboard. The simplest auth for programmatic / agent clients — no OAuth flow required; the key acts as its owning user. in: header name: X-API-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.