reseller

GET /v1/reseller/program

The org's wholesale reseller agreement.

Tutti gli endpoint reseller

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione reseller.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Returns 404 when the org is not enrolled — "not a reseller" is a state the screen renders, and the same 404 is what an out-of-scope org gets, so this is not an existence oracle. Requires `reseller.view`.

Parametri

NomeTipoObbligatorioChe cos'è
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…

Risposta

NomeTipoObbligatorioChe cos'è
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<pending, active, suspended>Set by Zinn®, never by the reseller. `pending` can price but not sell.
billing_dayintegerDay 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_bpsintegerBasis 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_entitybooleanWhether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet.
can_sellboolean
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_atstring

Errori che questo endpoint può restituire

401 · 403 · 404 · 429