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

# Update auto-top-up configuration

> Creates or updates the organization's automatic top-up rule: the balance threshold at which the saved payment method is charged off-session and the amount to add. Owner, admin, or billing role required. The charge itself is fired by the scheduled worker when the balance crosses the threshold.



## OpenAPI

````yaml /openapi.yaml put /api/v1/billing/auto-topup
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/billing/auto-topup:
    put:
      tags:
        - Billing
      summary: Update auto-top-up configuration
      description: >-
        Creates or updates the organization's automatic top-up rule: the balance
        threshold at which the saved payment method is charged off-session and
        the amount to add. Owner, admin, or billing role required. The charge
        itself is fired by the scheduled worker when the balance crosses the
        threshold.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - enabled
                - threshold_minor
                - recharge_amount_minor
                - currency
              properties:
                enabled:
                  type: boolean
                  description: Whether auto-top-up should be active.
                threshold_minor:
                  type: integer
                  description: >-
                    Balance, in minor units (cents), at or below which a charge
                    is triggered.
                recharge_amount_minor:
                  type: integer
                  description: >-
                    Amount, in minor units (cents), to add; must exceed the
                    threshold.
                max_monthly_minor:
                  type: integer
                  nullable: true
                  description: Optional monthly cap, in minor units.
                currency:
                  type: string
                  description: ISO-4217 currency; must match the org's payment currency.
                clear_cap:
                  type: boolean
                  description: >-
                    Set true to explicitly clear the monthly cap; otherwise a
                    null max_monthly_minor leaves the stored cap unchanged.
            example:
              enabled: true
              threshold_minor: 500
              recharge_amount_minor: 5000
              max_monthly_minor: 50000
              currency: USD
      responses:
        '200':
          description: The persisted auto-top-up configuration after the update.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                      threshold_minor:
                        type: integer
                      recharge_amount_minor:
                        type: integer
                      max_monthly_minor:
                        type: integer
                        nullable: true
                      currency:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  enabled: true
                  threshold_minor: 500
                  recharge_amount_minor: 5000
                  max_monthly_minor: 50000
                  currency: USD
                meta:
                  request_id: req_01HZY8EXAMPLE
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````