reseller
GET /v1/reseller/clients/{orgId}/plan
Which plan this client is on, and what it costs you.
Xaqiijinta aqoonsiga
U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda reseller.view; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.
Meesha aqoonsiga ururkaagu galayo
Bankani wuxuu qaataa aqoonsiga ururkaaga URL-ka dhexdiisa, sida orgId. Ku beddel wadada dhexdeeda — ma jiro madax (header) ama cabbir weydiin (query parameter) beddeli kara.
Aqoonsiga ururkaagu wuxuu ku yaallaa shaashada furayaasha API ee dashboard-kaaga, oo ku xiga furaha laftiisa. Waa isku aqoonsi wicitaan kasta oo aad sameyso.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
-H "Authorization: Bearer zdk_live_…"Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Details
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.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
orgId (path) | Uuid | Haa | One of your client organizations. |
org_id (query) | Uuid | Maya | 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 | Maya | ISO 4217 code the wholesale figure is quoted in. Defaults to `USD`. |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
client_org_id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | string | Maya | 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 | Maya | — |
plan_name | string | Maya | — |
interval | string | Maya | — |
created | boolean | Haa | 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 | Maya | What Zinn® charges you per period. `null`, never `0`, when unpriced. |
wholesale_currency | string | Maya | — |
Cilladaha ay bartaani soo celin karto
401 · 403 · 404 · 429