tenancy
GET /v1/orgs/{orgId}/closure-plan
What closing this organization would do.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте 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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
orgId (path) | Uuid | Иә | Organization ID (UUIDv7). |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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