Get Usage method 🪪 Sub-Accounts

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

Usage

modular.ts

import { MailChannelsClient, SubAccounts } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const subAccounts = new SubAccounts(mailchannels)

const { data, error } = await subAccounts.getUsage('validhandle123')

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { data, error } = await mailchannels.subAccounts.getUsage('validhandle123')

Params

• handle string required: The handle of the sub-account to query usage stats for.

Response

• data SubAccountsUsage | null nullable
  • endDate string optional: The end date of the current billing period (ISO 8601 format).
  • startDate string optional: The start date of the current billing period (ISO 8601 format).
  • total number guaranteed: The total usage for the current billing period.
  • monthlyLimit number guaranteed: The effective monthly limit for the current billing period. A limit of zero means the account cannot send any messages. For sub-accounts with no explicit limit set (i.e., -1), the monthly limit for the parent account is returned.
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request. This field is intended for diagnostic use only and should not be relied upon.
  • type string guaranteed: A string identifier for the type of error. This field is intended for diagnostic use only and should not be relied upon.
  • response Record<string, unknown> | null nullable: An object containing the response, if available. This field may be null if no response is available or if the error is not related to an HTTP request or if the response is not a JSON object.

Type declarations

Signature

async function getUsage (handle: string): Promise<SubAccountsUsageResponse>

Response type declarations

interface ErrorResponse {
  message: string;
  statusCode: number | null;
  type: ErrorType;
  response: Record<string, unknown> | null;
}

type DataResponse<T> = {
  data: T;
  error: null;
} | {
  data: null;
  error: ErrorResponse;
};

Usage type declarations

interface SubAccountsUsage {
  endDate?: string;
  startDate?: string;
  total: number;
  monthlyLimit: number;
}

type SubAccountsUsageResponse = DataResponse<SubAccountsUsage>;

Source

Source • Playground • Docs • Tests