Docs
Billing

Set auto-reload

PUT
/v1/billing/inference-credits/auto-reload

Charges the saved card amount of inference credits whenever your org's balance falls below below, and returns its credits. amount is at least below, so that one reload is enough. A reload whose card is declined pauses auto-reload, and saving the setting again resumes it. An org whose inference is invoiced, or not billed, needs no credits and answers 409 invalid_state. Only owners signed in to the console can call it.

Authorization

oauth2 org:write
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:write

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

Request Body

application/json
  1. body
below*DollarAmount

What a reload buys, $5.00 to $999,999.99, and at least below.

Match^[0-9]{1,6}(\.[0-9]{2})?$
amount*DollarAmount

What a reload buys, $5.00 to $999,999.99, and at least below.

Match^[0-9]{1,6}(\.[0-9]{2})?$

Response Body

Your org's inference credits.

application/json
  1. response

Your org's prepaid inference credits.

currency*string
balance*string

What is left, to the millionth of a dollar. It goes below zero by what requests in flight cost as it ran out.

invoiced*boolean

Whether your org's inference is billed monthly under a contract instead, and never refused for its balance.

exempt*boolean

Whether your org's inference is not billed at all, so it needs no credits and is never refused for its balance.

autoReload?

Buy amount of credits whenever the balance falls below below. Absent while it is off.

Example Request
curl -X PUT 'https://api.cloud.confidential.ai/v1/billing/inference-credits/auto-reload' \  -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' \  -H 'Content-Type: application/json' \  -d '{  "below": "10.00",  "amount": "50.00"}'
Example Response
{  "currency": "USD",  "balance": "42.180512",  "invoiced": false,  "exempt": false,  "autoReload": {    "below": "10.00",    "amount": "50.00",    "paused": false  }}