reseller

GET /v1/reseller/currencies

The currencies your clients are quoted in.

All reseller endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the reseller.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/reseller/currencies \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Every currency we can charge in, with offered saying whether your clients may be quoted in it. offers_all: true means you have made no choice and your clients get the full set — which is the state every programme starts in. sell_in_currency is what you are priced and settled in, which is a different question from what your customers browse in, and it is served only here and never to your clients. switcher: false removes the currency control from their panel entirely, so every one of your clients is quoted in default_currency. Requires reseller.view.

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoWhich of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404…

Response

NameTypeRequiredWhat it is
currenciesResellerCurrency[]Yes—
offers_allbooleanYesYou have made no choice, so your clients get every currency.
offered_countintegerYes—
total_countintegerYes—
default_currencystringYesWhat a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD.
sell_in_currencystringYesWhat you are priced and settled in, resolved — never empty, and never disclosed to your clients.
switcherbooleanYesWhether the currency control renders in your clients' panel at all. false quotes every client in default_currency.

Errors this endpoint can return

401 · 403 · 404 · 429