tenancy

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

Change what this organization is invoiced in.

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso billing.payment.manage; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint toma el id de tu organización directamente en la URL, como orgId. Sustitúyelo en la ruta; no hay ninguna cabecera ni parámetro de consulta que sirva para ello.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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> }'

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

⚖️ 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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`orgId (path)`	`Uuid`	Sí	Organization ID (UUIDv7).

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`currency`	`string`	Sí	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`	No	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…

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`dry_run`	`boolean`	Sí	True when nothing was applied.
`from_currency`	`string`	Sí	—
`to_currency`	`string`	Sí	—
`rate`	`string`	Sí	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[]`	Sí	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`	Sí	Live subscriptions now priced from the catalogue in the new currency.
`subscriptions_unpriced`	`integer`	Sí	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`	Sí	Issued invoices keeping the old currency, by design. Includes any still due.

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429