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

# Retrieve usage

> Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires `read`.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/usage
openapi: 3.1.0
info:
  title: Sendbaze API
  version: '1.0'
  description: >
    Transactional email and SMS for Africa. Send from your own domain through
    Amazon SES in Cape Town.

    Every send returns an id immediately; delivery is reported by webhook and in
    the dashboard logs.
  contact:
    name: Sendbaze support
    email: support@sendbaze.com
    url: https://www.sendbaze.com
servers:
  - url: https://api.sendbaze.com
security:
  - bearerAuth: []
tags:
  - name: Emails
  - name: Templates
  - name: Domains
  - name: Suppressions
  - name: Webhooks
  - name: SMS
  - name: Usage
paths:
  /v1/usage:
    get:
      tags:
        - Usage
      summary: Retrieve usage
      description: >-
        Your plan, the current billing period, how much of each allowance is
        used and remaining, prepaid SMS credits and domains in use. Requires
        `read`.
      operationId: getUsage
      responses:
        '200':
          description: Usage for the current period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
              example:
                plan:
                  id: starter
                  name: Starter
                  priceRand: 249
                period:
                  start: '2026-10-23T18:00:00.000Z'
                  end: '2026-11-23T18:00:00.000Z'
                emails:
                  used: 4210
                  included: 10000
                  remaining: 5790
                sms:
                  used: 300
                  included: 300
                  remaining: 0
                  credits: 1000
                domains:
                  used: 1
                  included: 2
components:
  schemas:
    Usage:
      type: object
      required:
        - plan
        - period
        - emails
        - sms
        - wallet
        - overage
        - domains
      properties:
        plan:
          type: object
          properties:
            id:
              type: string
              enum:
                - free
                - starter
                - growth
                - scale
                - payg
            name:
              type: string
            priceRand:
              type: number
        period:
          type: object
          properties:
            start:
              type: string
              format: date-time
            end:
              type: string
              format: date-time
              description: When the allowance resets.
        emails:
          type: object
          properties:
            used:
              type: integer
            included:
              type:
                - integer
                - 'null'
            remaining:
              type:
                - integer
                - 'null'
            daily:
              type:
                - object
                - 'null'
              description: >-
                Live emails counted today against the plan's daily cap; null
                when the plan has none.
              properties:
                used:
                  type: integer
                cap:
                  type: integer
        sms:
          type: object
          properties:
            used:
              type: integer
            included:
              type:
                - integer
                - 'null'
            remaining:
              type:
                - integer
                - 'null'
            credits:
              type: integer
              description: Prepaid SMS credits
              used once the allowance is gone.: null
        wallet:
          type: object
          description: >-
            The rand wallet. Pays sends beyond the allowance, and every send on
            pay as you go.
          properties:
            balanceRand:
              type: number
        overage:
          type:
            - object
            - 'null'
          description: >-
            Postpaid overage accepted this period and the spend cap it stops at;
            null on plans without overage.
          properties:
            emails:
              type: integer
            sms:
              type: integer
            amountRand:
              type: number
            spendCapRand:
              type: number
        domains:
          type: object
          properties:
            used:
              type: integer
            included:
              type:
                - integer
                - 'null'
        warmup:
          type:
            - object
            - 'null'
          description: >-
            Set while the organisation is warming up on the shared pool; null
            once complete.
          properties:
            day:
              type:
                - integer
                - 'null'
              description: Day of warm-up
              starting at 1.: null
            cap:
              type:
                - integer
                - 'null'
              description: Today's cap on live email.
            sentToday:
              type: integer
            resetsAt:
              type: string
              format: date-time
              description: Start of the next UTC day
              when the cap advances.: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates
        and returns ids without sending.

````

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