tenancy

GET `/v1/orgs/{orgId}/closure-plan`

What closing this organization would do.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Unde merge ID-ul organizației tale

Acest punct final preia ID-ul organizației tale direct în URL, sub forma orgId. Înlocuiește-l în cale — nu există niciun antet sau parametru de interogare care să țină locul acestuia.

ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/closure-plan \
  -H "Authorization: Bearer zdk_live_…"

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Parametri

Nume	Tip	Obligatoriu	Ce este
`orgId (path)`	`Uuid`	Da	Organization ID (UUIDv7).

Răspuns

Nume	Tip	Obligatoriu	Ce este
`org_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_type`	`string`	Da	—
`site_ids`	`Uuid[]`	Da	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[]`	Da	D-W15-11 — client orgs re-parented to Zinn®. Never torn down.
`retained_domain_ids`	`Uuid[]`	Da	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`	Da	⚖️ 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`	Da	ISO-4217 code for `forfeited_credit_minor`.
`outstanding_minor`	`integer`	Da	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`	Da	ISO 4217 code for `outstanding_minor`; empty when nothing is owed.
`blocked_by_balance`	`boolean`	Da	True when the closure would be refused and the org suspended instead.

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 429