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

# Get wallet and pricing

> Balance in cents plus how your SMS price is worked out: your own price, a volume tier, or the standard price.

Scope: `wallet:read`.

All `…Cents` amounts are integers in KES cents (100 = KES 1.00).



## OpenAPI

````yaml /openapi.json get /wallet
openapi: 3.1.0
info:
  title: Messaly API
  version: 1.0.0
  description: >-
    SMS, WhatsApp, email, contacts and CRM for your business. Amounts are in
    KES. Authenticate with an API key (Settings → API keys). A key can be
    limited to scopes and to IP addresses; a key with no scopes can call every
    endpoint here.
servers:
  - url: https://app.telaven.com/api/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
    description: Wallet balance and SMS pricing.
  - name: SMS
    description: Send SMS and read messages and analytics.
  - name: SMS campaigns
    description: Create, schedule and send SMS campaigns to lists and tags.
  - name: Contacts
    description: Contacts and contact lists.
  - name: WhatsApp
    description: Send approved WhatsApp templates.
  - name: Email
    description: Email campaigns and unsubscribes.
  - name: CRM
    description: Deals, companies and pipelines.
paths:
  /wallet:
    get:
      tags:
        - Account
      summary: Get wallet and pricing
      description: >-
        Balance in cents plus how your SMS price is worked out: your own price,
        a volume tier, or the standard price.


        Scope: `wallet:read`.


        All `…Cents` amounts are integers in KES cents (100 = KES 1.00).
      operationId: getWallet
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                pricing:
                  source: tier
                  defaultRateCents: 90
                  topups30dCents: 6000000
                  tier:
                    label: Growth
                    minTopup30dCents: 5000000
                    rateCents: 80
                  nextTier:
                    label: Scale
                    minTopup30dCents: 10000000
                    rateCents: 70
                wallet:
                  balance: 1443750
                  balanceKes: '14437.50'
                  totalLoaded: 1500000
                  totalSpent: 56250
                  smsRateCents: 80
                  estimatedSmsRemaining: 18046
                  alertThreshold: null
                  alertThresholdKes: null
                  belowThreshold: false
                recentTransactions:
                  - id: t1…
                    type: sms_debit
                    amount: -180
                    balanceBefore: 1443930
                    balanceAfter: 1443750
                    description: SMS (2 messages)
                    referenceId: 6f1c…
                    createdAt: '2026-11-12T09:30:01.000Z'
                businessName: Your Business
        '401':
          description: No API key, or the key is wrong, disabled or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key doesn't have the scope this endpoint needs, or it's used
            from an address its IP allowlist doesn't include.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            More than 120 requests in a minute with this key. Wait for the
            number of seconds in Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Something went wrong on our side. Retry with backoff. A POST sent
            with an Idempotency-Key replays this same error for that key,
            because the request may have partly run: check the result before
            trying again with a new key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable code where one exists, e.g. INSUFFICIENT_BALANCE.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer tlv_…'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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