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

# Get usage and credit balance

> Owner or billing role. Reports total recorded usage and its current settled credit balance; both are unbounded (all usage recorded so far), not scoped to a billing period.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/organizations/{organization_id}/usage
openapi: 3.1.0
info:
  title: Bonya Compute REST API
  version: 0.1.0
  description: >
    Public REST and WebSocket surface on TApi behind Caddy. Non-2xx responses
    are RFC 9457 application/problem+json with a stable machine-readable code.
    WebSocket endpoints are HTTP GET upgrades; their options travel in the START
    frame, never in query strings.
servers:
  - url: https://api.bonya.ai
    description: Production
security:
  - personalApiKey: []
  - supabaseJwt: []
tags:
  - name: Sandboxes
    description: Create, look up, list, pause, fork, snapshot, and delete sandboxes.
  - name: Snapshots
    description: Named point-in-time copies of a sandbox that new sandboxes can start from.
  - name: Templates
    description: Saved, versioned launch configurations for sandboxes.
  - name: Registry Connections
    description: Credentials for pulling private container images.
  - name: Secrets
    description: Write-only secrets and secret sets injected into sandboxes and jobs.
  - name: Previews
    description: Expose a sandbox port as an HTTPS URL.
  - name: Exec
    description: Run a command in a sandbox, buffered or over a TTY.
  - name: Sessions
    description: Named, persistent command sessions that outlive a connection.
  - name: Filesystem
    description: Read, write, and manage files inside a sandbox.
  - name: Jobs
    description: Managed, tracked runs of a command or script.
  - name: Job Schedules
    description: Cron, interval, or one-shot timing wrapped around a job.
  - name: Organizations
    description: Organization membership, administration and usage reporting.
  - name: Invitations
    description: Invite members to an organization and accept invitations.
  - name: API Keys
    description: Personal API key management.
  - name: Device Login
    description: Browser-based login for the CLI.
paths:
  /v1/organizations/{organization_id}/usage:
    get:
      tags:
        - Organizations
      summary: Get usage and credit balance
      description: >-
        Owner or billing role. Reports total recorded usage and its current
        settled credit balance; both are unbounded (all usage recorded so far),
        not scoped to a billing period.
      operationId: getOrganizationUsage
      parameters:
        - $ref: '#/components/parameters/OrganizationID'
      responses:
        '200':
          description: Usage and credit standing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationUsageResponse'
        default:
          $ref: '#/components/responses/Problem'
      security:
        - supabaseJwt: []
components:
  parameters:
    OrganizationID:
      name: organization_id
      in: path
      required: true
      schema:
        type: string
  schemas:
    OrganizationUsageResponse:
      type: object
      required:
        - usage
        - credit
      properties:
        usage:
          type: object
          required:
            - compute_seconds
            - storage_hours
            - members
          properties:
            compute_seconds:
              type: number
            storage_hours:
              type: number
            members:
              type: array
              items:
                $ref: '#/components/schemas/BillingMemberUsage'
        credit:
          type: object
          description: >-
            The provider's currently settled wallet balance, not the locally
            cached effective verdict the Create path enforces on; the two can
            differ because this balance does not subtract uninvoiced usage.
          required:
            - balance
            - blocked
          properties:
            balance:
              type: number
            blocked:
              type: boolean
    BillingMemberUsage:
      type: object
      description: >-
        One member's share of usage. An empty user id is the unattributed bucket
        -- usage whose opening actor record was lost -- reported as
        unattributed: true rather than an empty user_id, so a consumer cannot
        mistake it for a member whose id failed to render. Exactly one of
        user_id or unattributed is present.
      required:
        - compute_seconds
        - storage_hours
      properties:
        user_id:
          type: string
        unattributed:
          type: boolean
        compute_seconds:
          type: number
        storage_hours:
          type: number
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
  responses:
    Problem:
      description: RFC 9457 problem
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    personalApiKey:
      type: http
      scheme: bearer
      description: >-
        Personal byk_ API key; user-principal, resolved to a tenant by org
        context.
    supabaseJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Supabase-issued session JWT; required for org, invite, and key
        management.

````

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