Get automatic top-up settings

GET

billing

auto-topup

Error

A valid request URL is required to generate request examples

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

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

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<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.

Response

Automatic top-up 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.

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": 123,
  "used_this_month": 123
}

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

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

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

LLM

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

License

Supply Chain

CLI

Billing

Workspaces

Get automatic top-up settings

Authorizations

Response