GET /v1/mail/allowance
What the caller's plan grants for mailboxes.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu mail.view; ključ bez nje se odbija s kodom 403, a ne 404.
Gdje dolazi ID vaše organizacije
Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X GET https://api.zinndigital.com/v1/mail/allowance \
-H "Authorization: Bearer zdk_live_…"Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
org_id (query) | Uuid | Ne | The organization to resolve for; defaults to the caller's own when unambiguous. |
fqdn (query) | string | Ne | Resolve for this hostname. Adds the domain source — free mailboxes on a domain we hold the registration for. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
offered_providers | MailProvider[] | Da | 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 | Da | Whether the plan includes mailboxes at an operable size. |
box_quota_mb | integer | Da | Per-mailbox size in MB. 0 means no per-mailbox cap. |
mailbox_limit | integer | Da | 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> | Da | 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… |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 422 · 429