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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429