reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
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 toma el id de tu organización directamente en la URL, como orgId. Sustitúyelo en la ruta; no hay ninguna cabecera ni parámetro de consulta que sirva para ello.
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/clients/{orgId}/plan \
-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
The client's live plan, or nulls when they are not on one yet. `wholesale_amount_minor` is what Zinn® charges **you** per period for it — integer minor units, `null` and never `0` when the catalogue does not price it in the currency asked for. Requires `reseller.view`. An organization that is not one of your clients is a `404`, not a `403`, so this cannot be used to discover that an organization exists.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
orgId (path) | Uuid | Sí | One of your client organizations. |
org_id (query) | Uuid | No | Which of YOUR organizations is asking. Required only when you belong to more than one. Not to be confused with the path parameter, which is your client. |
currency (query) | string | No | ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
client_org_id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | string | No | Pass this as `subscription_id` on `createSite`. Null when the client is on no plan — provisioning a site in that state is what leaves it unbilled. |
plan_code | string | No | — |
plan_name | string | No | — |
interval | string | No | — |
created | boolean | Sí | True when this call granted the plan, false when the client was already on it. A retried provision needs the difference without inferring it from a timestamp. |
wholesale_amount_minor | integer | No | What Zinn® charges you per period. `null`, never `0`, when unpriced. |
wholesale_currency | string | No | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429