reseller

PATCH /v1/reseller/program

Change your own wholesale settings.

All reseller endpoints

Authentication

Send an API key as a bearer token. The key must carry the reseller.manage 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 PATCH https://api.zinndigital.com/v1/reseller/program \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Billing anchor day and the default markup applied to plans you have not priced explicitly. ⛔ `status` is not settable here — approving yourself as a reseller is not a self-service act. Requires `reseller.manage`.

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 r…

Request body

NameTypeRequiredWhat it is
billing_dayintegerNo
default_markup_bpsintegerNo
bills_clients_directlybooleanNoTurn on to invoice your own clients yourself — we stop issuing to them from the next run. Nothing already issued changes: an invoice is immutable. Turning it back off resumes is…
collect_on_platform_gatewaybooleanNoTurn OFF to refuse your clients' payments rather than let them settle on Zinn®'s account while you have no gateway connected. Your clients then cannot buy until you connect one;…

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<pending, active, suspended>YesSet by Zinn®, never by the reseller. `pending` can price but not sell.
billing_dayintegerYesDay of month the wholesale statement closes. Capped at 28 so every month has one — an anchor that moves double-bills at the seam.
default_markup_bpsintegerYesBasis points added to Zinn®'s list price for plans you have not priced explicitly. 0 means "sell at list", which is not zero margin — you still keep the wholesale discount.
legal_entity_idUuid | nullNoYour own issuing entity for invoices to your clients.
has_invoicing_entitybooleanYesWhether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet.
can_sellbooleanYes
bills_clients_directlybooleanNoWhether you invoice your own clients outside our system. When `true` we raise no document to them at all, and `has_invoicing_entity` being false is then a finished state rather…
collect_on_platform_gatewaybooleanNoWhether your clients may check out on Zinn®'s payment account when you have usable gateway connected of your own. `true` (the default) means a client is never blocked by your on…
created_atstringYes

Errors this endpoint can return

401 · 403 · 404 · 422 · 429