> ## 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 a billing alert

> Updates the mutable fields of a billing alert (threshold, recipients, action, cooldown, enabled state) for the caller's organization. Owner, admin, or billing role required.



## OpenAPI

````yaml /openapi.yaml patch /api/v1/billing/alerts/{id}
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/alerts/{id}:
    patch:
      tags:
        - Billing
      summary: Update a billing alert
      description: >-
        Updates the mutable fields of a billing alert (threshold, recipients,
        action, cooldown, enabled state) for the caller's organization. Owner,
        admin, or billing role required.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Any subset of the mutable alert fields; at least one must be
                provided.
              properties:
                name:
                  type: string
                  maxLength: 120
                threshold_type:
                  type: string
                  enum:
                    - spend_percent
                    - spend_amount
                    - balance_remaining
                    - daily_spend
                threshold_value:
                  type: number
                currency:
                  type: string
                notify_emails:
                  type: array
                  items:
                    type: string
                    format: email
                notify_sms_numbers:
                  type: array
                  items:
                    type: string
                action_on_hit:
                  type: string
                  enum:
                    - notify
                    - pause_outbound
                    - block_outbound
                cooldown_hours:
                  type: integer
                enabled:
                  type: boolean
            example:
              threshold_value: 90
              action_on_hit: pause_outbound
              enabled: true
      responses:
        '200':
          description: The updated billing alert.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      alert:
                        type: object
                        properties:
                          id:
                            type: string
                          organization_id:
                            type: string
                          name:
                            type: string
                          threshold_type:
                            type: string
                          threshold_value:
                            type: number
                          currency:
                            type: string
                          notify_emails:
                            type: array
                            items:
                              type: string
                          notify_sms_numbers:
                            type: array
                            items:
                              type: string
                          action_on_hit:
                            type: string
                          last_triggered_at:
                            type: string
                            format: date-time
                            nullable: true
                          cooldown_hours:
                            type: integer
                          enabled:
                            type: boolean
                          created_by:
                            type: string
                            nullable: true
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  alert:
                    id: alert_01HZY8ALERT
                    organization_id: org_01HZY8ORG
                    name: 80% of monthly budget
                    threshold_type: spend_percent
                    threshold_value: 90
                    currency: USD
                    notify_emails:
                      - billing@example.com
                    notify_sms_numbers: []
                    action_on_hit: pause_outbound
                    last_triggered_at: null
                    cooldown_hours: 24
                    enabled: true
                    created_by: user_01HZY8USER
                    created_at: '2026-08-01T09:00:00.000Z'
                    updated_at: '2026-08-02T11:59:00.000Z'
                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_*)

````