reseller

GET /v1/reseller/program

The org's wholesale reseller agreement.

כל נקודות הקצה מסוג reseller

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה reseller.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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

פרמטרים

שםסוגנדרשמה זה
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…

תשובה

שםסוגנדרשמה זה
idUuidכןUUIDv7 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_dayintegerכן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_bpsintegerכן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_idUuid | nullלאYour own issuing entity for invoices to your clients.
has_invoicing_entitybooleanכןWhether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet.
can_sellbooleanכן
bills_clients_directlybooleanלא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_gatewaybooleanלא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_atstringכן

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 429