tenancy

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

What closing this organization would do.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Tempat ID organisasi Anda dimasukkan

Endpoint ini menggunakan id organisasi Anda di dalam URL itu sendiri, sebagai orgId. Gantikan ke dalam path — tidak ada header atau parameter kueri yang dapat menggantikannya.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`orgId (path)`	`Uuid`	Ya	Organization ID (UUIDv7).

Tanggapan

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

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429