Orbit Billing API

Org billing reads — wallet, usage, ledger

GitHub OpenAPI

Operations 4

GET /api/v1/orgs/{id}/quota Get the org's hosting quota #
GET /api/v1/orgs/{id}/usage Get the org's per-day usage #
GET /api/v1/orgs/{id}/ledger Get the org's credit ledger #
GET /api/v1/orgs/{id}/wallet Get the org's wallet #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-billing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

orbitapps-io-billing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orbit Apps Billing API
  version: 1.0.0
  description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Billing
  description: Org billing reads — wallet, usage, ledger
paths:
  /api/v1/orgs/{id}/quota:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        description: Org id from GET /api/v1/orgs
      responses:
        '200':
          description: One entry per environment, dev to prod.
          content:
            application/json:
              schema:
                title: Quotas
                type: object
                properties:
                  data:
                    type: array
                    items:
                      title: Quota
                      description: One environment's hosting quota, shared by every app the org runs in it.
                      type: object
                      properties:
                        env:
                          description: dev | uat | prod.
                          type: string
                        error:
                          description: Why the quota could not be read.
                          type: string
                        cpu:
                          description: CPU limits, millicores.
                          type: object
                          properties:
                            limit:
                              description: What the environment may hold. Null when the quota does not cap it.
                              oneOf:
                              - type: integer
                              - type: 'null'
                            used:
                              description: What it holds now.
                              type: integer
                          required:
                          - limit
                          - used
                          additionalProperties: false
                        memory:
                          description: Memory limits, MiB.
                          type: object
                          properties:
                            limit:
                              description: What the environment may hold. Null when the quota does not cap it.
                              oneOf:
                              - type: integer
                              - type: 'null'
                            used:
                              description: What it holds now.
                              type: integer
                          required:
                          - limit
                          - used
                          additionalProperties: false
                        cpu_requests:
                          description: CPU reserved, millicores.
                          type: object
                          properties:
                            limit:
                              description: What the environment may hold. Null when the quota does not cap it.
                              oneOf:
                              - type: integer
                              - type: 'null'
                            used:
                              description: What it holds now.
                              type: integer
                          required:
                          - limit
                          - used
                          additionalProperties: false
                        memory_requests:
                          description: Memory reserved, MiB.
                          type: object
                          properties:
                            limit:
                              description: What the environment may hold. Null when the quota does not cap it.
                              oneOf:
                              - type: integer
                              - type: 'null'
                            used:
                              description: What it holds now.
                              type: integer
                          required:
                          - limit
                          - used
                          additionalProperties: false
                        runner:
                          description: What one more runner pod holds, so what a deploy needs free; same units as `uses`.
                          type: object
                          properties:
                            cpu:
                              type: integer
                            memory:
                              type: integer
                            cpu_requests:
                              type: integer
                            memory_requests:
                              type: integer
                          required:
                          - cpu
                          - memory
                          - cpu_requests
                          - memory_requests
                          additionalProperties: false
                        uses:
                          type: array
                          items:
                            title: QuotaUse
                            description: What one app's pods, or the shared database, hold.
                            type: object
                            properties:
                              app_id:
                                description: The app. Null for the environment's shared database.
                                oneOf:
                                - type: string
                                  format: uuid
                                - type: 'null'
                              title:
                                oneOf:
                                - type: string
                                - type: 'null'
                              role:
                                description: runner | admin | api | mcp | database | …
                                oneOf:
                                - type: string
                                - type: 'null'
                              cpu:
                                description: CPU limit, millicores.
                                type: integer
                              memory:
                                description: Memory limit, MiB.
                                type: integer
                              cpu_requests:
                                description: CPU reserved, millicores.
                                type: integer
                              memory_requests:
                                description: Memory reserved, MiB.
                                type: integer
                            required:
                            - app_id
                            - title
                            - role
                            - cpu
                            - memory
                            - cpu_requests
                            - memory_requests
                            additionalProperties: false
                      required:
                      - env
                      additionalProperties: false
                required:
                - data
                additionalProperties: false
        '404':
          description: Org does not exist, or the caller has no visibility (intentionally identical shapes).
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Billing
      summary: Get the org's hosting quota
      description: 'What each environment may hold, what it holds now, and which app holds it. Every app the org runs in one environment shares its quota, and a deploy the quota cannot hold is refused. CPU is in millicores and memory in MiB; `cpu`/`memory` are limits, `cpu-requests`/`memory-requests` what is reserved. An environment the org runs nothing in is left out.


        Authorization: any active member (viewer included).'
      operationId: getApiV1OrgsByIdQuota
      x-operation-id-source: derived
  /api/v1/orgs/{id}/usage:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        description: Org id from GET /api/v1/orgs
      responses:
        '200':
          description: Per-day usage, sorted by day ascending.
          content:
            application/json:
              schema:
                title: UsageSeries
                type: object
                properties:
                  data:
                    type: array
                    items:
                      title: UsageDay
                      description: One day's usage cost (cents) split by resource type.
                      type: object
                      properties:
                        day:
                          description: YYYY-MM-DD.
                          type: string
                        by_type:
                          description: resource-type → cents (e.g. hosting_uptime, ai_tokens).
                          type: object
                          additionalProperties: {}
                        total:
                          description: Day total, cents.
                      required:
                      - day
                      - by_type
                      - total
                      additionalProperties: false
                required:
                - data
                additionalProperties: false
        '404':
          description: Org does not exist, or the caller has no visibility (intentionally identical shapes).
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Billing
      summary: Get the org's per-day usage
      description: 'Daily cost series (cents) split by resource type — hosting uptime and AI tokens. Every meter counts (open, closed, settled) so history is complete.


        Authorization: any active member (viewer included).'
      operationId: getApiV1OrgsByIdUsage
      x-operation-id-source: derived
  /api/v1/orgs/{id}/ledger:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        description: Org id from GET /api/v1/orgs
      - in: query
        name: limit
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 50
        description: Max rows (1-50, default 20).
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          minimum: 0
        description: Result offset (default 0).
      responses:
        '200':
          description: Ledger entries, newest first.
          content:
            application/json:
              schema:
                title: Ledger
                type: object
                properties:
                  data:
                    type: array
                    items:
                      title: LedgerEntry
                      description: One immutable credit movement.
                      type: object
                      properties:
                        description:
                          oneOf:
                          - type: string
                          - type: 'null'
                        amount:
                          description: Cents moved.
                          oneOf:
                          - type: integer
                          - type: 'null'
                        reversal_of:
                          description: The entry this one reverses, for refunds.
                          oneOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                        unit_cost:
                          oneOf:
                          - type: integer
                          - type: 'null'
                        entry_type:
                          description: credit | debit.
                          oneOf:
                          - type: string
                          - type: 'null'
                        balance_after:
                          description: Wallet balance after this entry.
                          oneOf:
                          - type: integer
                          - type: 'null'
                        reference:
                          description: External correlator — invoice id, deployment id.
                          oneOf:
                          - type: string
                          - type: 'null'
                        id:
                          description: Stable UUIDv7 identifier.
                          type: string
                          format: uuid
                        tx_type:
                          description: purchase | bonus | usage | refund | adjustment.
                          oneOf:
                          - type: string
                          - type: 'null'
                        units:
                          oneOf:
                          - type: integer
                          - type: 'null'
                        feature:
                          description: Consuming feature on debits (hosting, ai).
                          oneOf:
                          - type: string
                          - type: 'null'
                        provider:
                          oneOf:
                          - type: string
                          - type: 'null'
                        created_at:
                          oneOf:
                          - type: string
                          - type: 'null'
                      required:
                      - id
                      - entry_type
                      - tx_type
                      - amount
                      - balance_after
                      additionalProperties: false
                  limit:
                    type: integer
                  offset:
                    type: integer
                required:
                - data
                - limit
                - offset
                additionalProperties: false
        '404':
          description: Org does not exist, or the caller has no visibility (intentionally identical shapes).
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Billing
      summary: Get the org's credit ledger
      description: 'The immutable audit trail of credit movements — purchases, bonuses, usage charges, refunds — newest first, offset-paginated (limit 1-50, default 20). The end of the trail is reached when fewer than `limit` entries return.


        Authorization: any active member (viewer included).'
      operationId: getApiV1OrgsByIdLedger
      x-operation-id-source: derived
  /api/v1/orgs/{id}/wallet:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        description: Org id from GET /api/v1/orgs
      responses:
        '200':
          description: The wallet position. Zeros with null currency/status when the org has no wallet yet.
          content:
            application/json:
              schema:
                title: Wallet
                description: The org's prepaid credit position, in cents.
                type: object
                properties:
                  balance:
                    description: Cash on hand, before live AI-meter consumption.
                    type: integer
                  usable:
                    description: Balance minus unsettled meter cost — what's actually spendable right now.
                    type: integer
                  refundable:
                    description: Unused PAID principal — bonus credits are never refundable.
                    type: integer
                  capacity:
                    description: The wallet's 'full mark' for progress displays.
                    type: integer
                  currency:
                    oneOf:
                    - type: string
                    - type: 'null'
                  status:
                    description: active | suspended | closed. Null when the org has no wallet yet.
                    oneOf:
                    - type: string
                    - type: 'null'
                  dunning_since:
                    description: When usable went negative; null while healthy.
                    oneOf:
                    - type: string
                    - type: 'null'
                required:
                - balance
                - usable
                - refundable
                - capacity
                additionalProperties: false
        '404':
          description: Org does not exist, or the caller has no visibility (intentionally identical shapes).
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Billing
      summary: Get the org's wallet
      description: 'The prepaid credit position, all in cents: `balance` (cash on hand), `usable` (balance minus unsettled meter cost — what a deploy''s affordability check sees), and `refundable` (unused paid principal; bonus credits never refund).


        Top-ups happen in Studio — this surface is read-only.


        Authorization: any active member (viewer included).'
      operationId: getApiV1OrgsByIdWallet
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: 'An Orbit api token, sent as `Authorization: Bearer <token>`.


        Mint one with the RFC 8628 device-authorization grant (`POST /api/v1/device/code`, then poll `POST /api/v1/device/token`), or from Studio.


        Every token carries a scope set from the `[verb resource]` RBAC catalog — `read:app`, `write:deployment`, `manage:secret`, and so on. The full vocabulary is published as `scopes_supported` at `/.well-known/oauth-protected-resource` (RFC 9728) and `/.well-known/oauth-authorization-server` (RFC 8414). Grant an agent the narrowest set that does its job.'
externalDocs:
  description: Full documentation
  url: https://docs.orbitapps.io
x-id:
- reitit.openapi/default