tenancy

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

What closing this organization would do.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Nơi điền id tổ chức của bạn

Endpoint này nhận mã tổ chức của bạn trực tiếp trong URL dưới dạng orgId. Hãy thay thế nó vào đường dẫn — không có header hoặc query parameter nào có thể thay thế được.

Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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.

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`orgId (path)`	`Uuid`	Có	Organization ID (UUIDv7).

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`org_id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_type`	`string`	Có	—
`site_ids`	`Uuid[]`	Có	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[]`	Có	D-W15-11 — client orgs re-parented to Zinn®. Never torn down.
`retained_domain_ids`	`Uuid[]`	Có	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`	Có	⚖️ 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`	Có	ISO-4217 code for `forfeited_credit_minor`.
`outstanding_minor`	`integer`	Có	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`	Có	ISO 4217 code for `outstanding_minor`; empty when nothing is owed.
`blocked_by_balance`	`boolean`	Có	True when the closure would be refused and the org suspended instead.

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 429