tenancy
GET /v1/orgs/{orgId}/closure-plan
What closing this organization would do.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Kung saan mapupunta ang id ng iyong organisasyon
Kinukuha ng endpoint na ito ang id ng iyong organisasyon sa mismong URL bilang orgId. Palitan ito sa path — walang header o query parameter na gagawa nito sa halip.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/closure-plan \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
orgId (path) | Uuid | Oo | Organization ID (UUIDv7). |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_type | string | Oo | — |
site_ids | Uuid[] | Oo | 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[] | Oo | D-W15-11 — client orgs re-parented to Zinn®. Never torn down. |
retained_domain_ids | Uuid[] | Oo | 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 | Oo | ⚖️ 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 | Oo | ISO-4217 code for `forfeited_credit_minor`. |
outstanding_minor | integer | Oo | 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 | Oo | ISO 4217 code for `outstanding_minor`; empty when nothing is owed. |
blocked_by_balance | boolean | Oo | True when the closure would be refused and the org suspended instead. |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 429