אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה reseller.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PATCH https://api.zinndigital.com/v1/reseller/program \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
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`.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id (query) | Uuid | לא | 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… |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
billing_day | integer | לא | — |
default_markup_bps | integer | לא | — |
bills_clients_directly | boolean | לא | 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 | לא | 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;… |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
id | Uuid | כן | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<pending, active, suspended> | כן | Set by Zinn®, never by the reseller. `pending` can price but not sell. |
billing_day | integer | כן | 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 | כן | 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 | לא | Your own issuing entity for invoices to your clients. |
has_invoicing_entity | boolean | כן | Whether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet. |
can_sell | boolean | כן | — |
bills_clients_directly | boolean | לא | 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 | לא | 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 | כן | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429