tenancy
GET /v1/orgs/{orgId}/closure-plan
What closing this organization would do.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントでは、URL内に組織IDを orgId として直接指定します。パスの中にその値を代入してください。この動作を代替するヘッダーやクエリパラメータはありません。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/closure-plan \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A **pure read** — opens no transport, arms no workflow, writes nothing — computed by the same function `DELETE /v1/orgs/{orgId}` runs, so the summary a customer confirms is the plan that then executes. ⛔ Gated on `org.delete`, not `org.read`: the plan is a complete inventory of the account (every site, every client org, every retained domain) plus what it owes.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
orgId (path) | Uuid | はい | Organization ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_type | string | はい | — |
site_ids | Uuid[] | はい | Sites that will be torn down, through the ordinary teardown — so they land in `DeletedSite` and stay restorable for the whole retention window. |
reparented_org_ids | Uuid[] | はい | D-W15-11 — client orgs re-parented to Zinn®. Never torn down. |
retained_domain_ids | Uuid[] | はい | D-W15-12 — domains that keep renewing and stay the customer's. Reported so nobody discovers on an invoice what closing did not stop paying for. |
forfeited_credit_minor | integer | はい | ⚖️ Wallet credit this organization holds and will **LOSE** on closure — *"credit is not returnable ever, even on account closure etc."* (owner ruling, 2026-08-22). ⛔ Reported fo… |
forfeited_credit_currency | string | はい | ISO-4217 code for `forfeited_credit_minor`. |
outstanding_minor | integer | はい | Minor units owed (D-W15-13). Mixed currencies report the largest single-currency total, never a sum — adding minor units across currencies is the §2.8 error. |
outstanding_currency | string | はい | ISO 4217 code for `outstanding_minor`; empty when nothing is owed. |
blocked_by_balance | boolean | はい | True when the closure would be refused and the org suspended instead. |
このエンドポイントが返すエラー
401 · 403 · 404 · 429