Docs
Billing

Get your billing

GET
/v1/billing

Returns how your org pays: the status of its Stripe subscription, as Stripe names it, or none before an owner has added a payment method with POST /v1/billing/checkout. Your usage is billed from the start of the subscription, at the end of each month. Only people signed in to the console can read it.

Authorization

oauth2 org:read
headerAuthorizationBearer <token>

A person's access token, sent as Authorization: Bearer <token>, from the authorization code flow with PKCE (S256). A CLI on a machine without a browser can use the device flow (RFC 8628) at https://auth.confidential.ai/oauth2/device_authorization instead. Ask for the resource https://api.cloud.confidential.ai (RFC 8707): a token issued for any other resource, the MCP server's included, is refused. A token acts for one person in one org, with the scopes of the person's role there whatever the client asks for, so ask the authorization server for none of the scopes below; they are listed so that each operation can name the ones it needs. Access tokens last minutes, and a refresh token is replaced at every use.

Scope: org:read

Header Parameters

Api-Version*string

The API version the request is written against. This document describes 2026-10-15. A missing header returns 400 api_version_required, and a version the API does not serve returns 400 unsupported_api_version.

X-Correlation-ID?string

An id of your own for this request, or for a group of requests, to find them in our logs and yours. Logged with the request and returned unchanged in X-Correlation-ID. The request id itself is always the API's own, in X-Request-ID.

Match^[A-Za-z0-9._:-]+$
Length1 <= length <= 128
Org-Context?string

Admin keys only: the id of the org to act in. Required with an admin key, together with Access-Reason; with any other credential it returns 400 invalid_request. Every request that carries it is recorded in that org's operator-access log.

Match^org-[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Length5 <= length <= 63
Access-Reason?string

Admin keys only: why the operator is acting in the org, such as a support ticket. Required with Org-Context. Recorded, verbatim, in the org's operator-access log.

Match^[^\x00-\x1F\x7F]+$
Length10 <= length <= 500

Response Body

How your org pays.

application/json
  1. response

How your org pays for its usage.

paymentRequired*boolean

Whether your org must add a payment method, or settle its invoices, before it can start anything billed: while it is true, those operations answer 402 payment_required.

status*string

The org's Stripe subscription status, or none before an owner has added a payment method. active and trialing are paid; past_due and unpaid have an invoice that failed to pay. Open set; accept values not listed.

Example Request
curl -X GET 'https://api.cloud.confidential.ai/v1/billing' \  -H 'Api-Version: 2026-10-15' \  -H 'X-Correlation-ID: rollout-2026-10-22' \  -H 'Access-Reason: Support ticket 4821: customer asked why i-6d3f9h2k8mzr failed'
Example Response
{  "status": "active",  "paymentRequired": false}