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

# Get account status

> Plan, credit and service health for the account. The app shows the same page at https://app.wazobiamail.com/status. Internal database and Redis health are not returned.



## OpenAPI

````yaml /customer-openapi.json get /status
openapi: 3.1.0
info:
  title: WazobiaMail API
  version: 1.0.0
  description: >-
    Customer-facing WazobiaMail API. Base URL
    https://app.wazobiamail.com/api/v1. Every response uses the {success,
    message, data} envelope. This specification covers the integration API:
    API-key and public operations. Sign-in, registration, password reset and
    account settings are supported in the app and are not listed here, although
    a dashboard key can call the account operations. The dashboard key carries
    wildcard permissions; the scoped sending key documented below can only send.
    Customer responses omit internal email providers, tenant/queue routing, raw
    upstream payloads and stored service credentials. See /guides/api-responses
    for the response contract and migration guidance. Download the OpenAPI
    specification at https://wazobiamail.com/openapi.json. API-owned JSON
    response field names use camelCase, including pagination; user-defined data
    and third-party protocol payloads retain their own keys.
  contact:
    name: WazobiaMail Support
    url: https://wazobiamail.com/contact
servers:
  - url: https://app.wazobiamail.com/api/v1
security:
  - apiKey: []
tags:
  - name: Account
    description: >-
      Profile, password, two-factor, notifications and account data. Account
      status, plan, units and health.
  - name: Sending
    description: Sending API keys, messages, domains, SMTP access and engagement.
  - name: Mailboxes
    description: Hosted mailboxes and their credentials.
  - name: Relays
    description: Customer SMTP relay configurations.
  - name: Billing
    description: Plans, subscriptions, invoices, payments and email credits.
  - name: Plans
    description: >-
      Plan catalogue entitlements and the effective limits of the current
      account's plan.
  - name: Support
    description: Support tickets.
paths:
  /status:
    get:
      tags:
        - Account
      summary: Get account status
      description: >-
        Plan, credit and service health for the account. The app shows the same
        page at https://app.wazobiamail.com/status. Internal database and Redis
        health are not returned.
      responses:
        '200':
          description: Account status retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      plan:
                        type: object
                        properties:
                          id:
                            type: string
                            example: pro
                          name:
                            type: string
                            example: Pro Plan
                          status:
                            type: string
                            example: active
                          billingInterval:
                            type: string
                            example: monthly
                          startDate:
                            type: string
                            format: date-time
                          endDate:
                            type: string
                            format: date-time
                          autoRenew:
                            type: boolean
                      units:
                        type: object
                        properties:
                          monthlyAllocation:
                            type: integer
                            example: 10000
                          subscriptionUsed:
                            type: integer
                            example: 2500
                          subscriptionRemaining:
                            type: integer
                            example: 7500
                          purchasedBalance:
                            type: integer
                            example: 5000
                          totalRemaining:
                            type: integer
                            example: 12500
                          unlimited:
                            type: boolean
                      health:
                        type: object
                        properties:
                          database:
                            type: string
                            enum:
                              - up
                              - down
                          redis:
                            type: string
                            enum:
                              - up
                              - down
        '401':
          description: Unauthorized
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Dashboard API key created at
        https://app.wazobiamail.com/dashboard/smtp-api. Send operations also
        accept a narrower sending key created through POST /sending/api-keys;
        every other operation needs the dashboard key.
      x-default: YOUR_API_KEY

````

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