> ## Documentation Index > Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a project's billing summary > The current billing period's plan, usage and usage-based cost for the organization that owns the project. Totals are organization-wide; only `usage.project_bytes` is the project's own share. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/projects/{id}/billing/summary openapi: 3.1.0 info: title: Qumo Deploy REST API description: > The Qumo Deploy control plane: organizations, projects, signing keys, machine identities, access control, audit and billing. Relay credentials are not issued here: your app signs them with its own [signing keys](/guides/signing-keys). Every operation here is generated against the routes the server registers and checked in CI, so an operation in this reference exists and a route missing from it is deliberately internal (relay mesh, webhooks, probes, operator-only and browser sign-in routes). Errors are JSON objects with one `error` field. What each status code means is in [Error codes](/guides/error-codes); the token scope each permission needs is in [Scopes and permissions](/guides/scopes-permissions). version: 1.0.0 servers: - url: https://api.qumo-deploy.com description: Public API (Bearer tokens only; cookies are ignored) security: [] tags: - name: Account description: The signed-in user's own sessions, tokens, security settings and data. - name: Device flow description: OAuth 2.0 device authorization, used by `qumod login`. - name: Organizations description: Organizations, their members and usage. - name: Projects description: Projects inside an organization. - name: Signing keys description: Keys your app signs relay credentials with. - name: Relays description: Where clients of a broadcast path connect. - name: Identities description: Machine identities, their tokens and IP allowlists. - name: Access control description: Roles, IAM bindings and invitations. - name: Audit description: The audit log and its webhook. - name: Notifications description: Notification policies. - name: Billing description: Plans, usage cost, budgets, invoices and payment methods. - name: Pricing description: Public price list. paths: /v1/projects/{id}/billing/summary: get: tags: - Billing summary: Get a project's billing summary description: | The current billing period's plan, usage and usage-based cost for the organization that owns the project. Totals are organization-wide; only `usage.project_bytes` is the project's own share. operationId: getProjectBillingSummary parameters: - name: id in: path required: true description: The project ID. schema: type: string format: uuid example: 9b1d6e2f-4a3c-4f8b-a7e5-0c9d2b4f6e81 responses: '200': description: The billing summary. content: application/json: schema: $ref: '#/components/schemas/BillingSummary' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' security: - token: [] - cliSession: [] - sessionCookie: [] components: schemas: BillingSummary: type: object description: > The current billing period's plan, subscription and usage-based cost for an organization. Byte totals are organization-wide; only `usage.project_bytes` depends on the project named in the path. required: - plan - has_live_subscription - period - computed_at - usage - cost properties: plan: $ref: '#/components/schemas/BillingSummaryPlan' subscription_status: type: string description: | The Stripe subscription's status (for example `active`, `past_due`, `canceled`); omitted when the organization has no subscription. example: active has_live_subscription: type: boolean description: > Whether the organization has a Stripe subscription that has not ended. Checkout refuses a second subscription. example: true cancel_at: type: string format: date-time description: | When the live subscription ends, set once its cancellation is scheduled; the organization returns to Free then. Omitted while it renews. example: '2026-12-03T21:08:26Z' publishing_paused_until: type: string format: date-time description: | Set while the organization's budget has paused new publishing for reaching its monthly limit (stop at limit): when the pause ends, the end of the billing period. Omitted otherwise. example: '2026-11-20T08:30:00Z' period: $ref: '#/components/schemas/BillingPeriod' computed_at: type: string format: date-time description: >- When the server read the usage figures, not the time the data is as of. The figures come from the usage rollups, up to one usage-worker tick (about 5 minutes) older than this. example: '2026-11-03T09:15:42Z' usage: $ref: '#/components/schemas/BillingSummaryUsage' cost: $ref: '#/components/schemas/BillingSummaryCost' products: type: object description: >- Usage, included quota and overage per active product, keyed by SKU key. additionalProperties: $ref: '#/components/schemas/BillingProductUsage' BillingSummaryPlan: type: object required: - name properties: name: type: string description: The organization's plan. example: Pay as you go BillingPeriod: type: object description: | The billing period: the Stripe subscription's current period, or the calendar month (UTC) without one. required: - start - end properties: start: type: string format: date-time example: '2026-11-01T00:00:00Z' end: type: string format: date-time example: '2026-12-01T00:00:00Z' BillingSummaryUsage: type: object required: - total_bytes - project_bytes properties: total_bytes: type: integer format: int64 description: >- Organization-wide billed bytes this period across all active products, which is egress only. Ingress is not billed and not included; the usage endpoints report it. example: 268435456000 project_bytes: type: integer format: int64 description: >- The project's own egress this period (ingress is not included); always 0 on the organization summary. example: 53687091200 BillingSummaryCost: type: object required: - current_usd - overage_bytes - overage_usd properties: current_usd: type: number description: >- Usage-based cost so far this period, in USD. Excludes the subscription price, which Stripe bills. example: 13.47 overage_bytes: type: integer format: int64 description: >- Egress bytes beyond the included quotas (the first 100 GB on Pay as you go). example: 168435456000 overage_usd: type: number description: Cost of the overage, in USD. example: 13.47 BillingProductUsage: type: object required: - name - quota - overage - resources properties: name: type: string description: The product's display name. example: Relay quota: type: object required: - total_bytes - included_bytes properties: total_bytes: type: integer format: int64 description: >- The product's billed usage this period; for the relay product, egress. example: 268435456000 included_bytes: type: integer format: int64 description: >- Usage included in the plan before overage applies; 100000000000 (100 GB) for the relay product on Pay as you go. example: 100000000000 overage: type: object required: - billable_bytes - cost_usd - rate_usd_per_gb properties: billable_bytes: type: integer format: int64 description: Usage beyond the included quota. example: 168435456000 cost_usd: type: number description: Cost of that overage, in USD. example: 13.47 rate_usd_per_gb: type: number description: The overage rate, in USD per GB (10^9 bytes). example: 0.08 resources: type: array description: >- The product's billed usage broken down by metric. The relay product lists Egress only. items: type: object required: - name - value_bytes properties: name: type: string example: Egress value_bytes: type: integer format: int64 example: 268435456000 Error: type: object required: - error properties: error: type: string description: A human-readable message. example: organization_id is required responses: BadRequest: description: >- Malformed request or failed validation. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing or invalid credentials. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- Authenticated but not allowed (permission, token scope, IP allowlist or CSRF). See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: >- Not found, or not visible to the caller. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: token: type: http scheme: bearer bearerFormat: qumo_pat_ description: > A personal access token (`POST /v1/auth/tokens`) or a machine identity token (`POST /v1/projects/{project_id}/identities/{identity_id}/tokens`), both prefixed `qumo_pat_`. A token's scopes cap what it can do; see [Scopes and permissions](/guides/scopes-permissions). A personal token names no organization: on a route whose path names no project or organization, pass `?organization_id=`. cliSession: type: http scheme: bearer description: | The session token `qumod login` obtains through the device flow (`POST /v1/auth/device/token`). It acts as the signed-in user, like a console session, and needs no CSRF token. sessionCookie: type: apiKey in: cookie name: __Host-qumo_session description: | The console's browser session. Accepted only on the console origin (`https://console.qumo-deploy.com`), never on `api.qumo-deploy.com`. A request that changes state must also send `X-CSRF-Token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.