Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran reseller.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X PATCH https://api.zinndigital.com/v1/reseller/program \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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`.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
org_id (query) | Uuid | Tidak | Which 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… |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
billing_day | integer | Tidak | — |
default_markup_bps | integer | Tidak | — |
bills_clients_directly | boolean | Tidak | Turn 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_gateway | boolean | Tidak | Turn 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;… |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<pending, active, suspended> | Ya | Set by Zinn®, never by the reseller. `pending` can price but not sell. |
billing_day | integer | Ya | Day 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_bps | integer | Ya | Basis 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_id | Uuid | null | Tidak | Your own issuing entity for invoices to your clients. |
has_invoicing_entity | boolean | Ya | Whether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet. |
can_sell | boolean | Ya | — |
bills_clients_directly | boolean | Tidak | Whether 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_gateway | boolean | Tidak | Whether 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_at | string | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429