tenancy

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

What closing this organization would do.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

L'ID della tua organizzazione va qui

Questo endpoint accetta l'ID della tua organizzazione direttamente nell'URL come orgId. Sostituiscilo nel percorso: non sono presenti intestazioni o parametri di query alternativi.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Nome	Tipo	Obbligatorio	Che cos'è
`orgId (path)`	`Uuid`	Sì	Organization ID (UUIDv7).

Risposta

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

Errori che questo endpoint può restituire

401 · 403 · 404 · 429