GET /v1/mail/allowance
What the caller's plan grants for mailboxes.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
The preflight the "set up email" screen reads: whether the governing plan includes mailboxes, how large each one is, and how many a domain may have. Reports rather than refuses — an organization with no plan gets included: false and an upgrade prompt, not an error, because this is a read screen. Resolution walks up the parent_org chain, so a reseller's client organization inherits the reseller's plan (CLAUDE.md §2.3). source names where the answer came from. mailbox_limit is the smaller of the plan's mailboxes grant and the platform abuse ceiling, so it does vary by plan; -1 means both are uncapped. Requires mail.view. ⭐ Pass fqdn whenever the question is about one domain, which is nearly always. Since the owner's ruling of 2026-08-16 a domain registered with us — or transferred in — grants free mailboxes on itself, whatever the organization's hosting plan says, and that grant is only reachable when the hostname is supplied. Without fqdn this endpoint answers the narrower question "does anything the organization owns include mail at all", and a customer whose only product is a domain gets included: false followed by a successful mailbox creation — a screen disagreeing with its own API.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id (query) | Uuid | Nie | The organization to resolve for; defaults to the caller's own when unambiguous. |
fqdn (query) | string | Nie | Resolve for this hostname. Adds the domain source — free mailboxes on a domain we hold the registration for. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
offered_providers | MailProvider[] | Tak | The providers this organization may set a domain up on, in picker order — the one producer of the white-label rule (W40-MAIL). zinn is absent, not disabled, for an… |
included | boolean | Tak | Whether the plan includes mailboxes at an operable size. |
box_quota_mb | integer | Tak | Per-mailbox size in MB. 0 means no per-mailbox cap. |
mailbox_limit | integer | Tak | Mailboxes allowed per domain; -1 is uncapped. The smaller of the plan's mailboxes grant and the platform abuse ceiling: a plan may lower it, and a generous plan can never… |
source | string<staff, subscription, trial, domain, free, none> | Tak | Where the allowance came from. domain means the domain itself grants it — it is registered with us or was transferred in, so its mailboxes are free whatever the… |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 422 · 429