> ## Documentation Index > Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi.json put /billing/auto-topup openapi: 3.1.0 info: title: Strix API version: 1.0.0 description: >- Public REST API for the Strix autonomous penetration testing platform. Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks. servers: - url: /api/v1 description: Strix v1 API security: - BearerAuth: [] tags: - name: Scans description: Launch, monitor, and manage security scans. - name: Vulnerabilities description: View and triage discovered vulnerabilities. - name: Assets description: Domains and repositories registered for scanning. - name: Schedules description: Recurring scan schedules (Pro plan). - name: Search description: Search across issues, pentests, PR reviews, chats, assets and schedules. - name: Tokens description: Manage API tokens for authentication. - name: Webhooks description: Configure webhook subscriptions for real-time event notifications. - name: Organization description: Workspace configuration for the authenticated organization. - name: Members description: Manage organization members and roles. - name: Invitations description: List and revoke organization invitations. - name: PR Reviews description: Automated security review of pull requests. - name: Connectors description: Network connectors for scanning internal/private targets. - name: Knowledge description: >- Organization knowledge base: documents, policies, and repo profiles that steer the agent. - name: Uploads description: Upload source/code/documentation archives for whitebox scans. - name: Integrations description: Third-party integrations (GitLab, Bitbucket, ticketing). - name: Chat description: Conversational agent sessions. - name: Analytics description: Aggregate dashboard analytics. - name: Test Users description: >- Per-domain test accounts (with optional MFA) the agent authenticates as during scans. - name: License description: Self-hosted license state, entitlements, and aggregate usage. - name: Supply Chain description: >- SBOM inventory, supply-chain findings, scans, and policy for connected repositories. - name: CLI description: >- Device authorization endpoints that let the Strix CLI and coding agents sign in and receive an API token. - name: Billing description: Credit balance, agent-payable top-ups, and automatic top-up settings. - name: Workspaces description: List, create, and switch workspaces. - name: Asset Discovery description: >- Passive reconnaissance runs that map the organization's external attack surface, and the discovered-asset inventory they fill. - name: Containers description: >- Container registries, tracked images, image scans, findings, and SBOM components. - name: Run Logs description: Persisted engine logs and the diagnostics bundle of a self-hosted install. paths: /billing/auto-topup: put: tags: - Billing summary: Update automatic top-up settings description: >- 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. operationId: updateAutoTopupSettings requestBody: required: true content: application/json: schema: type: object properties: enabled: description: >- When true, Strix buys credits automatically when a scan needs more. type: boolean topup_credits: description: Number of credits to buy on each automatic top-up. type: integer minimum: 1 maximum: 10000 monthly_cap_credits: type: - integer - 'null' minimum: 1 maximum: 2147483647 description: >- Maximum automatically purchased credits per calendar month. An omitted field keeps the stored cap. An explicit null removes the cap. chat_cap_credits: type: - integer - 'null' minimum: 1 maximum: 2147483647 description: >- Maximum credits that automatic top-up buys for one chat. An omitted field keeps the stored limit. An explicit null removes the limit. required: - enabled - topup_credits responses: '200': description: Updated settings. content: application/json: schema: $ref: '#/components/schemas/AutoTopupSettings' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '503': $ref: '#/components/responses/ServiceUnavailable' security: - BearerAuth: - billing:write components: schemas: AutoTopupSettings: type: object properties: enabled: type: boolean description: True when automatic top-up is active. topup_credits: type: integer minimum: 1 maximum: 10000 description: Credits purchased for each automatic top-up. monthly_cap_credits: type: - integer - 'null' minimum: 1 maximum: 2147483647 description: >- Maximum automatically purchased credits per calendar month. Null removes the cap. chat_cap_credits: type: - integer - 'null' minimum: 1 maximum: 2147483647 description: >- 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`. used_this_month: type: integer description: Credits already purchased automatically this month. required: - enabled - topup_credits - monthly_cap_credits - chat_cap_credits - used_this_month ErrorResponse: type: object properties: detail: type: string description: Human-readable explanation of the error. code: type: string description: >- Stable machine-readable error code. `insufficient_scope` means the token does not hold the scope that this endpoint requires. required_scope: $ref: '#/components/schemas/ApiV1Scope' description: >- Scope that the caller must add to the token. Returned with the `insufficient_scope` code. docs: type: string format: uri description: Documentation page that explains how to resolve the error. hint: type: string description: >- One instruction that resolves the error. For `insufficient_scope`, a CLI session gets the `strix cloud session scopes set full` or `strix cloud login --scope-profile full` command, and an API token gets the settings page where the user creates a token with the scope. When the owner's role cannot hold the scope, the hint asks for a role change instead. required: - detail ApiV1Scope: type: string enum: - scans:read - scans:write - vulnerabilities:read - vulnerabilities:write - dependencies:read - schedules:read - schedules:write - assets:read - assets:write - organizations:read - organizations:write - members:read - members:write - invitations:read - invitations:write - webhooks:read - webhooks:write - tokens:write - audit:read - pr_reviews:read - pr_reviews:write - connectors:read - connectors:write - knowledge:read - knowledge:write - uploads:write - integrations:read - integrations:write - chat:read - chat:write - scans:message - analytics:read - llm:read - llm:write - test_users:read - test_users:write - discovery:read - discovery:write - license:read - supply_chain:read - supply_chain:write - billing:read - billing:write - containers:read - containers:write - logs:read responses: BadRequest: description: Bad request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid API token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Insufficient permissions or missing scope. A missing scope returns the `insufficient_scope` code, the `required_scope` field, and a `hint` with the command or page that grants the scope, so a client can request the correct scope and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Conflict: description: Conflict. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' ServiceUnavailable: description: Service unavailable. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer description: >- API token obtained from the Tokens endpoint or CLI device login. Include as `Authorization: Bearer `. Requests made with a managed CLI session also include `X-Strix-Workspace: ` to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.