reseller

PATCH /v1/reseller/program

Change your own wholesale settings.

Všechny koncové body reseller

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění reseller.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X PATCH https://api.zinndigital.com/v1/reseller/program \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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`.

Parametry

NázevTypPožadovánoCo to je
org_id (query)UuidNeWhich 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…

Tělo požadavku

NázevTypPožadovánoCo to je
billing_dayintegerNe
default_markup_bpsintegerNe
bills_clients_directlybooleanNeTurn 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_gatewaybooleanNeTurn 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;…

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusstring<pending, active, suspended>AnoSet by Zinn®, never by the reseller. `pending` can price but not sell.
billing_dayintegerAnoDay 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_bpsintegerAnoBasis 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 | nullNeYour own issuing entity for invoices to your clients.
has_invoicing_entitybooleanAnoWhether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet.
can_sellbooleanAno
bills_clients_directlybooleanNeWhether 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_gatewaybooleanNeWhether 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_atstringAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429