tenancy
GET /v1/orgs/{orgId}/closure-plan
What closing this organization would do.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Ця кінцева точка приймає ідентифікатор вашої організації безпосередньо в URL як orgId. Підставте його в шлях — немає заголовка чи параметра запиту, які б замінили це.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/closure-plan \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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 for… |
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