tenancy

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

What closing this organization would do.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont magában az URL-ben várja a szervezeted azonosítóját, mégpedig orgId formában. Helyettesítsd be az útvonalba – nincs olyan fejléc vagy lekérdezési paraméter, amely ezt helyettesítené.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`orgId (path)`	`Uuid`	Igen	Organization ID (UUIDv7).

Válasz

Név	Típus	Kötelező	Mi ez
`org_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_type`	`string`	Igen	—
`site_ids`	`Uuid[]`	Igen	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[]`	Igen	D-W15-11 — client orgs re-parented to Zinn®. Never torn down.
`retained_domain_ids`	`Uuid[]`	Igen	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`	Igen	⚖️ 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`	Igen	ISO-4217 code for `forfeited_credit_minor`.
`outstanding_minor`	`integer`	Igen	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`	Igen	ISO 4217 code for `outstanding_minor`; empty when nothing is owed.
`blocked_by_balance`	`boolean`	Igen	True when the closure would be refused and the org suspended instead.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429