Автентифікація
Надішліть ключ 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