> ## Documentation Index
> Fetch the complete documentation index at: https://docs.axilio.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update usage-alert settings

> Configures the low-balance alert: while enabled and the balance sits below the threshold, an alert stays open and surfaces in the dashboard. Negative-balance alerts are always on. Requires an admin-role caller: an API key carries its creator's organization role, so the key must belong to an org admin.



## OpenAPI

````yaml /api-reference/openapi-backend.json put /billing/usage-alerts
openapi: 3.1.0
info:
  description: Axilio backend HTTP API.
  title: Axilio API
  version: 0.85.0
servers:
  - url: https://api.axilio.ai/api/v1
    description: Production
security: []
tags:
  - name: API Keys
  - name: Billing
  - name: Files
  - name: Organization
  - name: Phones
  - name: Runs
  - name: Skill
  - name: Usage
  - name: Workflows
paths:
  /billing/usage-alerts:
    put:
      tags:
        - Billing
      summary: Update usage-alert settings
      description: >-
        Configures the low-balance alert: while enabled and the balance sits
        below the threshold, an alert stays open and surfaces in the dashboard.
        Negative-balance alerts are always on. Requires an admin-role caller: an
        API key carries its creator's organization role, so the key must belong
        to an org admin.
      operationId: billing_update_usage_alerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionUsageAlertSettings'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionUsageAlertSettingsResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V2ErrorModel'
          description: Error
      security:
        - apiKeyAuth: []
components:
  schemas:
    SubscriptionUsageAlertSettings:
      additionalProperties: false
      description: 'Usage-alert configuration: warn when the balance runs low.'
      properties:
        enabled:
          description: >-
            Whether low-balance alerts are active. Negative-balance alerts are
            always on.
          type: boolean
        threshold_cents:
          description: >-
            Alert while the balance sits below this amount, in cents. Must be
            positive.
          format: int64
          type: integer
      required:
        - enabled
        - threshold_cents
      type: object
    SubscriptionUsageAlertSettingsResponse:
      additionalProperties: false
      description: The org's usage-alert configuration and any open alerts.
      properties:
        active_alerts:
          description: >-
            Currently open alerts, oldest first. Empty when the balance is
            healthy.
          items:
            $ref: '#/components/schemas/SubscriptionActiveUsageAlert'
          type:
            - array
            - 'null'
        enabled:
          description: >-
            Whether low-balance alerts are active. Negative-balance alerts are
            always on.
          type: boolean
        threshold_cents:
          description: >-
            Alert while the balance sits below this amount, in cents. Must be
            positive.
          format: int64
          type: integer
      required:
        - active_alerts
        - enabled
        - threshold_cents
      type: object
    V2ErrorModel:
      additionalProperties: false
      description: >-
        Error response, following RFC 9457 (Problem Details for HTTP APIs).
        Returned with a application/problem+json content type.
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/V2ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    SubscriptionActiveUsageAlert:
      additionalProperties: false
      description: An open balance alert.
      properties:
        balance_cents:
          description: The balance when the alert opened, in cents. May be negative.
          format: int64
          type: integer
        kind:
          description: >-
            Which rule fired: the configurable low-balance threshold, or the
            balance going negative.
          enum:
            - low_balance
            - negative_balance
          type: string
        threshold_cents:
          description: >-
            The threshold in effect when the alert opened, in cents (0 for
            negative_balance).
          format: int64
          type: integer
        triggered_at:
          description: When the alert opened.
          format: date-time
          type: string
      required:
        - kind
        - threshold_cents
        - balance_cents
        - triggered_at
      type: object
    V2ErrorDetail:
      additionalProperties: false
      description: >-
        One specific problem within an error response, locating the offending
        part of the request.
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    apiKeyAuth:
      description: Customer API key (axl_ prefix).
      in: header
      name: X-Axilio-Api-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.