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

# Billing summary

> The workspace's plan, prepaid wallet balance (with auto-recharge settings and recent spend), and the current monthly usage period: included voice minutes, SMS segments, emails and AI video credits, how much of each is used, and the overage charged so far. For a per-category breakdown use `GET /v1/billing/usage`. Free: reads are never billed.



## OpenAPI

````yaml /openapi.json get /v1/billing
openapi: 3.1.0
info:
  title: LumisReach v1 API
  version: 1.0.0
  description: >-
    Programmatic access to the LumisReach voice platform — calls, numbers,
    caller trust, and brands.
  contact:
    name: LumisReach
    email: founders@lumisreach.com
servers:
  - url: https://api.lumisreach.com/api
security:
  - bearerAuth: []
tags:
  - name: Phone Numbers
  - name: Caller IDs
  - name: Enterprise Registration
  - name: Branded Calling
  - name: Calls
  - name: SMS
  - name: WebRTC
  - name: Reputation
  - name: Usage
  - name: Account
  - name: Billing
  - name: Conversation History
  - name: Documents
  - name: Lincoln AI
  - name: Quick Agent Actions
  - name: Sub-entities
paths:
  /v1/billing:
    get:
      tags:
        - Billing
      summary: Billing summary
      description: >-
        The workspace's plan, prepaid wallet balance (with auto-recharge
        settings and recent spend), and the current monthly usage period:
        included voice minutes, SMS segments, emails and AI video credits, how
        much of each is used, and the overage charged so far. For a per-category
        breakdown use `GET /v1/billing/usage`. Free: reads are never billed.
      operationId: v1_billing_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      plan:
                        type: string
                      subscription_status:
                        anyOf:
                          - type: string
                          - type: 'null'
                      is_trial:
                        type: boolean
                      currency:
                        type: string
                        const: USD
                      wallet:
                        type: object
                        properties:
                          balance_usd:
                            type: number
                            description: >-
                              Prepaid wallet balance that usage beyond the plan
                              draws from
                          is_paused:
                            type: boolean
                            description: >-
                              True when the wallet ran dry and billable actions
                              are paused
                          is_low:
                            type: boolean
                          auto_recharge:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                              threshold_usd:
                                type: number
                              amount_usd:
                                type: number
                              last_attempt_failed:
                                type: boolean
                            required:
                              - enabled
                              - threshold_usd
                              - amount_usd
                              - last_attempt_failed
                            additionalProperties: false
                          spend_last_24h_usd:
                            type: number
                          spend_last_7d_usd:
                            type: number
                        required:
                          - balance_usd
                          - is_paused
                          - is_low
                          - auto_recharge
                          - spend_last_24h_usd
                          - spend_last_7d_usd
                        additionalProperties: false
                      current_period:
                        anyOf:
                          - type: object
                            properties:
                              start:
                                type: string
                              end:
                                type: string
                              days_remaining:
                                type: number
                            required:
                              - start
                              - end
                              - days_remaining
                            additionalProperties: false
                          - type: 'null'
                        description: >-
                          The monthly usage window; null until the first
                          billable usage of the cycle
                      allowances:
                        type: object
                        properties:
                          voice_minutes:
                            type: object
                            properties:
                              used:
                                type: number
                              included:
                                type: number
                              remaining:
                                type: number
                              overage:
                                type: number
                              percent_used:
                                type: number
                            required:
                              - used
                              - included
                              - remaining
                              - overage
                              - percent_used
                            additionalProperties: false
                          sms_segments:
                            type: object
                            properties:
                              used:
                                type: number
                              included:
                                type: number
                              remaining:
                                type: number
                              overage:
                                type: number
                              percent_used:
                                type: number
                            required:
                              - used
                              - included
                              - remaining
                              - overage
                              - percent_used
                            additionalProperties: false
                          emails:
                            type: object
                            properties:
                              used:
                                type: number
                              included:
                                type: number
                              remaining:
                                type: number
                              overage:
                                type: number
                              percent_used:
                                type: number
                            required:
                              - used
                              - included
                              - remaining
                              - overage
                              - percent_used
                            additionalProperties: false
                          ai_video_credits:
                            type: object
                            properties:
                              used:
                                type: number
                              included:
                                type: number
                              remaining:
                                type: number
                              overage:
                                type: number
                              percent_used:
                                type: number
                            required:
                              - used
                              - included
                              - remaining
                              - overage
                              - percent_used
                            additionalProperties: false
                            description: 1 credit = $1 of AI video at cost
                        required:
                          - voice_minutes
                          - sms_segments
                          - emails
                          - ai_video_credits
                        additionalProperties: false
                      overage_charges_usd:
                        type: object
                        properties:
                          voice:
                            type: number
                          sms:
                            type: number
                          email:
                            type: number
                          ai_video:
                            type: number
                          total:
                            type: number
                        required:
                          - voice
                          - sms
                          - email
                          - ai_video
                          - total
                        additionalProperties: false
                    required:
                      - plan
                      - subscription_status
                      - is_trial
                      - currency
                      - wallet
                      - current_period
                      - allowances
                      - overage_charges_usd
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Conflict (incl. idempotency conflicts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            fields:
              type: object
              additionalProperties:
                type: string
            doc_url:
              type: string
              format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````