tenancy

POST `/v1/orgs/{orgId}/billing-currency`

Change what this organization is invoiced in.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.payment.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی، شناسه سازمان شما را مستقیماً در خود URL به صورت orgId دریافت می‌کند. آن را در مسیر جایگزین کنید؛ هیچ هدر یا پارامتر کوئری‌ای وجود ندارد که بتواند جایگزین آن شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X POST https://api.zinndigital.com/v1/orgs/{orgId}/billing-currency \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "currency": <string> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

⚖️ Owner ruling 2026-08-31 (W37-V). A customer may re-denominate their own organization. Three things happen and they are deliberately different: 1. **Invoices already issued are frozen.** An invoice is a legal document with a number; its currency, FX stamps and tax treatment stay as issued, for ever. ⚠️ An invoice that is still DUE keeps its old currency and will be collected in it — `invoices_left_in_old_currency` reports how many, so the screen can say so rather than let the customer discover it on a bill. 2. **Live subscriptions re-price from the CATALOGUE**, not by FX-converting the locked price. The catalogue's per-currency price is the number a page displayed and the business chose; a converted one would be invented and would drift on every rate move. A subscription whose plan has no price in the target currency is left in its original currency and counted in `subscriptions_unpriced` — never zeroed. 3. **Wallet credit is converted** at the day's rate, per purse, as a draw-down in the old currency plus a grant in the new sharing one reference. Credit is held per `(org, currency)` and currencies are never mixed, so leaving it would strand real money the customer could no longer spend. ⛔ A dedicated route rather than a field on `PATCH /v1/orgs/{orgId}`: a rename writes one column, this moves money. It requires `billing.payment.manage` — the person who may correct a typo in the account name is not necessarily the person who may re-denominate the balance. An org you cannot reach answers 404, not 403. ⭐ Send `dry_run: true` to get exactly these numbers **without** applying anything. The preview runs the real conversion inside a transaction it then rolls back, so it cannot disagree with the commit.

پارامترها

نام	نوع	الزامی	چیست
`orgId (path)`	`Uuid`	بله	Organization ID (UUIDv7).

بدنه درخواست

نام	نوع	الزامی	چیست
`currency`	`string`	بله	ISO-4217, the currency to invoice this organization in from now on. Must be one we can actually charge — enabled in the registry, not policy-blocked, and presentable by at least…
`dry_run`	`boolean`	خیر	Compute the change and report it without applying it. ⭐ The preview runs the real conversion in a transaction it rolls back, so the figures a customer confirms are the figur…

پاسخ

نام	نوع	الزامی	چیست
`dry_run`	`boolean`	بله	True when nothing was applied.
`from_currency`	`string`	بله	—
`to_currency`	`string`	بله	—
`rate`	`string`	بله	Units of `to_currency` per unit of `from_currency`, to ten decimal places. ⛔ A string: JSON has no decimal type, and a float here would be the one place in this path that br…
`converted`	`ConvertedPurse[]`	بله	The purses that moved. A purse whose balance rounds to zero in the target currency is left alone and is absent here — debiting it would destroy the customer's credit.
`subscriptions_repriced`	`integer`	بله	Live subscriptions now priced from the catalogue in the new currency.
`subscriptions_unpriced`	`integer`	بله	Live subscriptions whose plan has no price in the target currency. Left untouched in their original currency — never converted, never zeroed.
`invoices_left_in_old_currency`	`integer`	بله	Issued invoices keeping the old currency, by design. Includes any still due.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422 · 429

POST /v1/orgs/{orgId}/billing-currency