Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0652106151.4 KB
subaccounts

Get subaccount active plan.

Get subaccount active plan.

get/subaccounts/{Id}/active-plan

Path parameters

Idinteger required

Id

Response

Login successfull

ipstring

IP address to use for sending emails.

activeboolean required

Active subaccounts can be used for login purpose, while users can´t login to inactive subaccounts. Notice that in order to be able to send emails the subaccount subscription must also be active. User can set subaccounts to active / inactive from the dashboard.

subaccount_idinteger

Sub account Id

parent_idinteger

Sub account parent Id

limitinteger required

The ammount of emails the sub account is allowed to send over the period specified by plan_limit_interval. Value -1 means no limit.

sentinteger

The ammount of sent emails from the sub account over the current period.

last_usedstring nullable
plan_expirationstring nullable
plan_limit_interval'Daily' | 'Monthly' | 'Yearly'

Limit interval that specifies if the sub account sending limit is specified daily, monthly or yearly.

  • Important Note: The limit interval allways follows the main account limit.
expiredboolean

Expired if plan expiration date is overdue.

Example response

{
  "subaccount_id": 19302132,
  "parent_id": 22190623,
  "ip": "199.244.75.250",
  "active": true,
  "limit": 2000,
  "sent": 0,
  "last_used": null,
  "plan_expiration": "2023-01-17 00:00:00",
  "plan_limit_interval": "Monthly",
  "expired": false
}