Billing

Update automatic top-up settings

Not available on self-hosted deployments (returns 404). Update the automatic top-up settings for the organization. Automatic top-up charges the saved payment method when a scan or a chat needs more credits. The monthly cap applies to all automatic purchases. The chat limit applies to the automatic purchases made for one chat. To enable automatic top-up, the organization needs a usable saved card. If the organization has no saved card, or the card has expired, the API returns 409 with code no_payment_method or card_expired. If automatic top-up is not configured for this deployment, the API returns 503. An admin adds a card under Billing in the dashboard. Requires the billing:write scope and the admin role.

PUT

billing

auto-topup

Error

A valid request URL is required to generate request examples

{
  "enabled": true,
  "topup_credits": 5000,
  "monthly_cap_credits": 1073741824,
  "chat_cap_credits": 1073741824,
  "used_this_month": 123
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Body

application/json

enabled

boolean

required

When true, Strix buys credits automatically when a scan needs more.

topup_credits

integer

required

Number of credits to buy on each automatic top-up.

Required range: 1 <= x <= 10000

monthly_cap_credits

integer | null

Maximum automatically purchased credits per calendar month. An omitted field keeps the stored cap. An explicit null removes the cap.

Required range: 1 <= x <= 2147483647

chat_cap_credits

integer | null

Maximum credits that automatic top-up buys for one chat. An omitted field keeps the stored limit. An explicit null removes the limit.

Required range: 1 <= x <= 2147483647

Response

Updated settings.

enabled

boolean

required

True when automatic top-up is active.

topup_credits

integer

required

Credits purchased for each automatic top-up.

Required range: 1 <= x <= 10000

monthly_cap_credits

integer | null

required

Maximum automatically purchased credits per calendar month. Null removes the cap.

Required range: 1 <= x <= 2147483647

chat_cap_credits

integer | null

required

Maximum credits that automatic top-up buys for one chat. Null removes the limit. Manual purchases and scans are not affected. An admin can lift the limit for one chat with PUT /chat/{chatId}/auto-topup-limit.

Required range: 1 <= x <= 2147483647

used_this_month

integer

required

Credits already purchased automatically this month.

Error

A valid request URL is required to generate request examples

{
  "enabled": true,
  "topup_credits": 5000,
  "monthly_cap_credits": 1073741824,
  "chat_cap_credits": 1073741824,
  "used_this_month": 123
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Repositories

Update automatic top-up settings

Authorizations

Body

Response