tenancy
GET /v1/orgs/{orgId}/closure-plan
What closing this organization would do.
প্রমাণীকরণ
একটি বিয়ার টোকেন হিসেবে একটি এপিআই কি পাঠান। এই এন্ডপয়েন্টটি স্পেসিফিকেশনে কোনো নির্দিষ্ট অনুমতির কথা বলে না, তাই অনুমান না করে আপনার কি-কে এর জন্য ন্যূনতম প্রয়োজনীয় অনুমতি দিন এবং রেসপন্স পরীক্ষা করুন।
যেখানে আপনার অর্গানাইজেশন আইডি দেওয়া হবে
এই এন্ডপয়েন্টটি URL-এর মধ্যেই আপনার অর্গানাইজেশন আইডি নেয়, orgId হিসেবে। এটিকে পাথ-এ প্রতিস্থাপন করুন — এর পরিবর্তে কাজ করবে এমন কোনো হেডার বা কোয়েরি প্যারামিটার নেই।
আপনার ড্যাশবোর্ডের API কি স্ক্রিনে, কি-এর ঠিক পাশেই আপনার অর্গানাইজেশন আইডি রয়েছে। আপনি যে কলই করুন না কেন, সবগুলিতেই এই আইডি একই থাকে।
চেষ্টা করুন
কোণ বন্ধনীতে থাকা যেকোনো কিছু আপনার নিজস্ব মান দিয়ে এবং কী প্লেসহোল্ডারটি আপনার ড্যাশবোর্ডের একটি কী দিয়ে প্রতিস্থাপন করুন।
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/closure-plan \
-H "Authorization: Bearer zdk_live_…"লগ ইন করা আছে? আপনার ড্যাশবোর্ডের এপিআই কনসোল আপনার আসল অর্গানাইজেশন আইডি এবং আপনার নিজের কি পূরণ করে দেয়, এবং লাইভ এপিআই-এর বিপরীতে অনুরোধটি চালায় যাতে আপনি প্রকৃত প্রতিক্রিয়া দেখতে পান। এই এন্ডপয়েন্টটি এপিআই কনসোলে খুলুন
বিবরণ
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.
পরামিতি
| নাম | ধরন | আবশ্যক | এটি কী |
|---|---|---|---|
orgId (path) | Uuid | হ্যাঁ | Organization ID (UUIDv7). |
প্রতিক্রিয়া
| নাম | ধরন | আবশ্যক | এটি কী |
|---|---|---|---|
org_id | Uuid | হ্যাঁ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_type | string | হ্যাঁ | — |
site_ids | Uuid[] | হ্যাঁ | 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[] | হ্যাঁ | D-W15-11 — client orgs re-parented to Zinn®. Never torn down. |
retained_domain_ids | Uuid[] | হ্যাঁ | 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 | হ্যাঁ | ⚖️ 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 | হ্যাঁ | ISO-4217 code for `forfeited_credit_minor`. |
outstanding_minor | integer | হ্যাঁ | 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 | হ্যাঁ | ISO 4217 code for `outstanding_minor`; empty when nothing is owed. |
blocked_by_balance | boolean | হ্যাঁ | True when the closure would be refused and the org suspended instead. |
এই এন্ডপয়েন্ট থেকে যেসব ত্রুটি আসতে পারে
401 · 403 · 404 · 429