reseller
GET /v1/reseller/program
The org's wholesale reseller agreement.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso reseller.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Donde va el ID de tu organización
Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.
El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/reseller/program \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
org_id (query) | Uuid | No | 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… |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | string<pending, active, suspended> | Sí | Set by Zinn®, never by the reseller. `pending` can price but not sell. |
billing_day | integer | Sí | 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 | Sí | 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 | No | Your own issuing entity for invoices to your clients. |
has_invoicing_entity | boolean | Sí | Whether we hold the company details your client invoices are issued under. False means you cannot invoice a client yet. |
can_sell | boolean | Sí | — |
bills_clients_directly | boolean | No | 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 | No | 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 | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429