Entitlements (billing)

GET/api/v1/billing/entitlements

Requires anorganization API keywith the scopeaccount:read

Request

GET/api/v1/billing/entitlements

curl -X GET 'https://app.mailyte.com/api/v1/billing/entitlements' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/billing/entitlements', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/billing/entitlements",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/billing/entitlements');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/billing/entitlements")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- objectstringentitlements
- planobject
  What you have bought.
  - tierstringfree | paid
    free or paid. Every account has one: an account that has bought nothing reads free.
  - statusstringpending | active | past_due | suspended | cancelled
    The subscription's status. Null means there is no subscription.
- seatsobject
  Paid seats bought and in use, per tier. What a null on any leaf below means is stated ON THAT LEAF — this heading does not reach the field you are indexing into, and a caller reads the field it is using.
  - standardobject
    Seats of the standard tier. Both figures come from the entitlement snapshot, which counts them locally.
    - ownedinteger
      Seats bought at this tier. Null means unknown.
    - assignedinteger
      Seats in use. This can be more than owned after a downgrade. Null means unknown.
  - proobject
    Seats of the pro tier. Both figures come from the entitlement snapshot, which counts them locally.
    - ownedinteger
      Seats bought at this tier. Null means unknown.
    - assignedinteger
      Seats in use. This can be more than owned after a downgrade. Null means unknown.
  - workplaceobject
    Seats of the workplace tier. Both figures come from the entitlement snapshot, which counts them locally.
    - ownedinteger
      Seats bought at this tier. Null means unknown.
    - assignedinteger
      Seats in use. This can be more than owned after a downgrade. Null means unknown.
- mailbox_tiersobject
  What each mailbox tier gives one mailbox, the free tier included. For daily_send_limit, null means no limit; for storage_bytes and assistant_actions, null means unknown.
  - freeobject
    What the free tier grants ONE mailbox.
    - storage_bytesinteger
      Storage per mailbox, in bytes. Null means unknown.
    - daily_send_limitinteger
      Emails one mailbox of this tier may send per day. Null means no limit.
    - assistant_actionsinteger
      Assistant actions per mailbox per month. 0 means none. Null means unknown.
  - standardobject
    What the standard tier grants ONE mailbox.
    - storage_bytesinteger
      Storage per mailbox, in bytes. Null means unknown.
    - daily_send_limitinteger
      Emails one mailbox of this tier may send per day. Null means no limit.
    - assistant_actionsinteger
      Assistant actions per mailbox per month. 0 means none. Null means unknown.
  - proobject
    What the pro tier grants ONE mailbox.
    - storage_bytesinteger
      Storage per mailbox, in bytes. Null means unknown.
    - daily_send_limitinteger
      Emails one mailbox of this tier may send per day. Null means no limit.
    - assistant_actionsinteger
      Assistant actions per mailbox per month. 0 means none. Null means unknown.
  - workplaceobject
    What the workplace tier grants ONE mailbox.
    - storage_bytesinteger
      Storage per mailbox, in bytes. Null means unknown.
    - daily_send_limitinteger
      Emails one mailbox of this tier may send per day. Null means no limit.
    - assistant_actionsinteger
      Assistant actions per mailbox per month. 0 means none. Null means unknown.
- limitsobject
  Limits for your whole account. Null means no limit.
  - max_mailboxesinteger
    Free mailboxes you may have: five, or more if you had more before the pricing change. Mailboxes on seats are limited by your seats instead. Null means no limit.
  - max_domainsinteger
    Domains you may add. Null means no limit.
  - max_aliases_per_mailboxinteger
    Aliases each mailbox may have. Null means no limit.
  - max_team_membersinteger
    People you may invite to your account. Null means no limit.
- allowancesobject
  - app_send_monthlyinteger
    Emails a month from your Send plan and seats. 0 when you have none. Null means unknown. For today's limit, see GET /billing/usage.
  - send_credit_balanceinteger
    Your send credit balance, counted in emails, not money. To decide whether you can send right now, read GET /billing/usage, which shows the live figure. Null means unknown.
- featuresobject
  Feature entitlements. Whether a feature is GRANTED, not whether it is configured.
  - branded_webmailboolean
  - priority_supportboolean
  - dedicated_ipboolean
    Whether a dedicated IP may be requested. Its state is at GET /dedicated-ip.
- productsobject
  Send (email from your apps) and Marketing (campaigns and journeys), each bought separately from mailboxes.
  - sendobject
    - statusstringpending | active | past_due | suspended | cancelled
      The Send subscription's status. Null means there is no Send subscription.
    - planstring
      The Send plan you have. Null means none, so the free plan applies.
    - familystringfree | pro | scale
      Which Send plan sets the limits below: free when nothing is bought.
    - included_monthlyinteger
      Emails a month the Send plan includes; 0 on the free plan. Null means unknown.
    - log_daysinteger
      How many days of delivery logs you can see. Null means unknown.
    - webhooksinteger
      Webhooks you may add. Null means no limit.
    - sandbox_inboxesinteger
      Sandbox inboxes you may have. Null means unknown.
    - sandbox_monthlyinteger
      Emails a month your Sandbox accepts. Null means unknown.
  - marketingobject
    - statusstringpending | active | past_due | suspended | cancelled
      The Marketing subscription's status. Null means there is no Marketing subscription.
    - planstring
      The Marketing plan you have. Null means none; family says what applies.
    - familystringlegacy | free | starter | growth | premium
      Which Marketing plan sets the limits below. legacy is an account made before Marketing plans existed, without one: no limits, and campaigns are paid from send credits.
    - contactsinteger
      Subscribed contacts the plan covers. Null means no limit.
    - emails_monthlyinteger
      Marketing emails a month. Null means no limit (on legacy, each email is paid from credits).
    - segmentsinteger
      Segments you may have. Null means no limit.
    - journeysinteger
      Journeys that may be live or paused at once. Null means no limit.
    - journey_stepsinteger
      Steps one journey may have. Null means no limit.
    - usersinteger
      Team members who may use Marketing. Null means no limit.
- support_levelstringcommunity | email | priority | named
  The best support any product held includes.

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.