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

# Get vendor balance



## OpenAPI

````yaml /openapi/sms.json get /public/v1/vendors/balance
openapi: 3.0.3
info:
  title: Beem SMS API
  version: 1.0.0
  description: >-
    The Beem SMS API provides endpoints for sending SMS, checking balance,
    delivery reports, sender names, and SMS templates.
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://apisms.beem.africa
    description: Production server
  - url: https://dev-sms.beem.africa
    description: Staging server
security: []
tags: []
paths:
  /public/v1/vendors/balance:
    get:
      summary: Get vendor balance
      operationId: getVendorBalance
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      credit_balance:
                        description: Available SMS credit balance for your account.
                        type: number
                        format: float
                    additionalProperties: false
                    required:
                      - credit_balance
                additionalProperties: false
                required:
                  - data
        '401':
          description: Unauthorized — invalid or missing API credentials.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: API error code.
                    example: 120
                  message:
                    type: string
                    description: Error message.
                required:
                  - code
                  - message
                additionalProperties: true
              examples:
                invalidAuthentication:
                  summary: Invalid authentication
                  value:
                    code: 120
                    message: Invalid Authentication Parameters
      security:
        - basicAuth: []
        - accessToken: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Beem API credentials: API key as username, API secret as password.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Access token only. Send as Authorization: <token> — do not use a Bearer
        prefix.

````