Manage payment and invoices
Starts a Stripe Customer Portal session, where an owner of the org
changes its payment method, reads and pays its invoices, and cancels
its subscription. Open url in the browser within a few minutes.
An org that has never started POST /v1/billing/checkout returns
409 invalid_state. Only owners signed in to the console can call
it.
oauth2 org:writeAuthorizationBearer <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:write
Idempotency-Key*stringA unique key for this intent, such as a UUID. Reuse it for every
retry of the same request. A missing key returns
400 idempotency_key_required. See Idempotency above.
^[!-~]+$1 <= length <= 255Api-Version*stringThe 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?stringAn 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.
^[A-Za-z0-9._:-]+$1 <= length <= 128Org-Context?stringAdmin 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.
^org-[a-z0-9]([-a-z0-9]*[a-z0-9])?$5 <= length <= 63Access-Reason?stringAdmin 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.
^[^\x00-\x1F\x7F]+$10 <= length <= 500The Stripe Customer Portal session to open.
application/json- response
A Stripe page to open in the browser.
url*stringThe page, on Stripe's domain.
uriexpiresAt?stringWhen a Checkout page stops working; a new one can be started any time.
date-timecurl -X POST 'https://api.cloud.confidential.ai/v1/billing/portal' \ -H 'Idempotency-Key: 0b9d6c1e-5f8a-4c2e-9a51-2f7e0c3d4b18' \ -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'{ "url": "https://billing.stripe.com/p/session/test_a1b2c3"}Add a payment method POST
Starts a Stripe Checkout page where an owner of the org adds a payment method, in US dollars. Once it is saved, the org is subscribed to its usage prices, which `GET /v1/sizes` and the console show. Open `url` in the browser; Stripe sends the person back to the console's billing page, and `GET /v1/billing` shows the subscription once Stripe confirms it. An org whose subscription is live, any status other than `none`, `canceled` and `incomplete_expired`, returns `409 invalid_state`: change its payment method with `POST /v1/billing/portal`. A retry with the same `Idempotency-Key` returns the same page. Only owners signed in to the console can call it.
Get your inference credits GET
Returns your org's prepaid inference credits: the balance that inference usage draws down, and its auto-reload. While the balance is zero or less, inference refuses your org's keys with `402 payment_required` until an owner buys more. An org invoiced under a contract has `invoiced` true: its inference is billed monthly instead, and never refused for its balance. Only people signed in to the console can read it.