Node.js
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 read the limit for)");
const mailchannels = new MailChannels(PARENT_API_KEY);
const { data, error } = await mailchannels.subAccounts.getLimit(SUB_ACCOUNT_HANDLE);
if (error) {
console.error("Get sub-account limit failed:", error);
process.exit(1);
}
// A value of -1 means no explicit limit; the sub-account shares the parent's allocation.
console.log(data);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 read the limit for)")
mailchannels.api_key = parent_api_key
# A value of -1 means the sub-account has no explicit limit and is bounded
# only by the parent account's overall limit.
response = mailchannels.SubAccounts.Limits.retrieve(handle)
print(response)<?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);
// A value of -1 means the sub-account has no explicit limit and is bounded
// only by the parent account's overall limit.
$response = $client->subAccounts->limits->retrieve($sub_account_handle);
print_r($response->toArray());curl --request GET \
--url https://api.mailchannels.net/tx/v1/sub-account/{handle}/limit \
--header 'X-Api-Key: <x-api-key>'{
"sends": 123
}Retrieve Sub-account Limit
Retrieves the limit of a specified sub-account. A value of -1 indicates that the sub-account inherits the parent account’s limit, allowing the sub-account to utilize any remaining capacity within the parent account’s allocation.
GET
/
sub-account
/
{handle}
/
limit
Node.js
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 read the limit for)");
const mailchannels = new MailChannels(PARENT_API_KEY);
const { data, error } = await mailchannels.subAccounts.getLimit(SUB_ACCOUNT_HANDLE);
if (error) {
console.error("Get sub-account limit failed:", error);
process.exit(1);
}
// A value of -1 means no explicit limit; the sub-account shares the parent's allocation.
console.log(data);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 read the limit for)")
mailchannels.api_key = parent_api_key
# A value of -1 means the sub-account has no explicit limit and is bounded
# only by the parent account's overall limit.
response = mailchannels.SubAccounts.Limits.retrieve(handle)
print(response)<?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);
// A value of -1 means the sub-account has no explicit limit and is bounded
// only by the parent account's overall limit.
$response = $client->subAccounts->limits->retrieve($sub_account_handle);
print_r($response->toArray());curl --request GET \
--url https://api.mailchannels.net/tx/v1/sub-account/{handle}/limit \
--header 'X-Api-Key: <x-api-key>'{
"sends": 123
}Was this page helpful?
⌘I

