GET /v1/mail/free-tier
What a free mailbox is, and what it costs to provide.
認証
ベアラー トークンとして API キーを送信します。キーには mail.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/mail/free-tier \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The free mailbox tier's quota, per-organization ceiling and derived capacity. Requires mail.view. ⭐ Published rather than written down. Every figure is computed from the measured relay capacity and the configured quota, so raising the quota lowers the mailbox count and raises the stated per-mailbox cost with no second edit. A screen or a pricing page that restated these numbers would be a second expression of the same arithmetic, and would go stale the first time the quota moved.
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
available | boolean | はい | Whether free mailboxes are actually on offer. Two measured legs, not a switch. The first is "does mail land on our own relay" — true exactly when every mail hostname we… |
unavailable_cause | string<relay, headroom, > | はい | Which leg refused, so that two situations sharing one symptom stay distinguishable. relay means the mail hostnames are not ours — a routing decision. headroom means the relay… |
reserve_percent | integer | はい | How much of the relay is held back from the free tier for the mail somebody is paying for. Free and paid mailboxes share one disk, and the failure this prevents is a paying… |
offerable_bytes | integer | はい | Usable storage less the reserve — what the free tier may draw on. |
committed_bytes | integer | はい | Storage already promised to mailboxes on the relay — every mailbox, not only free ones, because a paid mailbox occupies the same disk. |
headroom_bytes | integer | はい | Offerable storage still unpromised. Negative when the relay is oversubscribed. |
unavailable_reason | string | はい | Why free mailboxes are not on offer, in a sentence an operator can act on. Empty when available is true. Names our own configuration rather than any supplier. |
relay_zone | string | はい | The apex of our own mail relay — the name available compares against. |
quota_mb | integer | はい | Per-mailbox size of a free mailbox, in MB. |
per_org_ceiling | integer | はい | How many free mailboxes one organization may hold. A ceiling rather than a target, and the only term a customer can move — which is what stops the offer running away. |
usable_bytes | integer | はい | Mail-available storage on one relay node, measured rather than assumed. |
node_monthly_eur | integer | はい | What one relay node costs per month. |
mailboxes_per_node | integer | はい | How many fully-used free mailboxes one node holds. |
orgs_per_node | integer | はい | How many organizations one node holds if every one fills its ceiling. |
worst_case_cost_per_mailbox_eur | number | はい | What a free mailbox costs per month, fully used. Worst case deliberately: a figure computed from average fill is a claim about customer behaviour dressed as a cost, and it is… |
このエンドポイントが返すエラー
401 · 403 · 429