Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền reseller.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Nơi điền id tổ chức của bạn
Điểm cuối này nhận org_id làm tham số truy vấn. Hãy bỏ trống để áp dụng cho toàn bộ cây thuê của bạn; hoặc truyền giá trị vào để thu hẹp phạm vi gọi về một tổ chức duy nhất.
Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X PATCH https://api.zinndigital.com/v1/reseller/program \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
org_id (query) | Uuid | Không | 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… |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
billing_day | integer | Không | — |
default_markup_bps | integer | Không | — |
bills_clients_directly | boolean | Không | 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 | Không | 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;… |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<pending, active, suspended> | Có | Set by Zinn®, never by the reseller. `pending` can price but not sell. |
billing_day | integer | Có | 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 | Có | 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 | Không | Your own issuing entity for invoices to your clients. |
has_invoicing_entity | boolean | Có | Whether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet. |
can_sell | boolean | Có | — |
bills_clients_directly | boolean | Không | 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 | Không | 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 | Có | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 422 · 429