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

# Retrieve Sub-account Usage Stats

> Retrieves usage statistics for the specified sub-account during the current billing period.



## OpenAPI

````yaml /email-api/api-reference/openapi.yaml get /sub-account/{handle}/usage
openapi: 3.0.0
info:
  contact:
    email: support@mailchannels.com
    name: MailChannels Corporation
  description: >
    This is the API reference for Email API. Here, you'll find more detailed
    information on every endpoint, including parameters, response formats, and
    error codes.
  title: Email API
  version: 1.4.0
servers:
  - url: https://api.mailchannels.net/tx/v1
security: []
tags:
  - name: Send
  - name: DKIM
  - name: Metrics
  - name: Sub-accounts
  - name: Suppression
  - name: Webhooks
  - name: Usage
  - name: Custom Tracking
paths:
  /sub-account/{handle}/usage:
    get:
      tags:
        - Sub-accounts
      summary: Retrieve Sub-account Usage Stats
      description: >-
        Retrieves usage statistics for the specified sub-account during the
        current billing period.
      parameters:
        - description: Handle of the sub-account to query usage stats for.
          in: path
          name: handle
          required: true
          schema:
            type: string
        - in: header
          name: X-Api-Key
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageStats'
          description: Successfully returned the usage stats.
        '404':
          description: Sub-account not found
        '500':
          description: Internal Server Error
      x-codeSamples:
        - label: Node.js
          lang: javascript
          source: >-
            import { MailChannels } from "mailchannels-sdk";


            const { PARENT_API_KEY, SUB_ACCOUNT_HANDLE } = process.env;

            if (!PARENT_API_KEY) throw new Error("Set PARENT_API_KEY (a
            parent-account API key) before running");

            if (!SUB_ACCOUNT_HANDLE) throw new Error("Set SUB_ACCOUNT_HANDLE
            (the sub-account to query)");


            const mailchannels = new MailChannels(PARENT_API_KEY);


            const { data, error } = await
            mailchannels.subAccounts.getUsage(SUB_ACCOUNT_HANDLE);


            if (error) {
              console.error("Get sub-account usage failed:", error);
              process.exit(1);
            }

            console.log(data);
        - label: Python
          lang: python
          source: |-
            import os
            import sys

            import mailchannels

            parent_api_key = os.environ.get("PARENT_API_KEY")
            handle = os.environ.get("SUB_ACCOUNT_HANDLE")
            if not parent_api_key:
                sys.exit("Set PARENT_API_KEY (a parent-account API key) before running")
            if not handle:
                sys.exit("Set SUB_ACCOUNT_HANDLE (the sub-account to query)")

            mailchannels.api_key = parent_api_key

            response = mailchannels.SubAccounts.retrieve_usage(handle)

            print(response)
        - label: PHP
          lang: php
          source: >-
            <?php


            require_once __DIR__ . '/vendor/autoload.php';


            use MailChannels\Client;


            $parent_api_key     = getenv('PARENT_API_KEY') or exit("Error:
            PARENT_API_KEY is not set\n");

            $sub_account_handle = getenv('SUB_ACCOUNT_HANDLE') or exit("Error:
            SUB_ACCOUNT_HANDLE is not set\n");


            $client = new Client(apiKey: $parent_api_key);


            $response =
            $client->subAccounts->retrieveUsage($sub_account_handle);


            print_r($response->toArray());
components:
  schemas:
    UsageStats:
      properties:
        period_end_date:
          description: The end date of the current billing period (ISO 8601 format).
          example: '2025-04-11'
          format: date
          type: string
        period_start_date:
          description: The start date of the current billing period (ISO 8601 format).
          example: '2025-03-12'
          format: date
          type: string
        total_usage:
          description: The total usage for the current billing period.
          example: 5000
          format: int64
          type: integer
      required:
        - total_usage
      type: object

````