reseller

GET /v1/reseller/clients/{orgId}/plan

Which plan this client is on, and what it costs you.

Vituo vyote vya reseller

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya reseller.view; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Kituo hiki cha mwisho kinachukua kitambulisho cha shirika lako katika URL yenyewe, kama orgId. Kiweke kwenye njia — hakuna kichwa au kigezo cha hoja ambacho kitafanya kazi badala yake.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

curl -X GET https://api.zinndigital.com/v1/reseller/clients/{orgId}/plan \
  -H "Authorization: Bearer zdk_live_…"

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

JinaAinaInayohitajikaKilicho hiki
orgId (path)UuidNdiyoOne of your client organizations.
org_id (query)UuidHapanaWhich 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)stringHapanaISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Majibu

JinaAinaInayohitajikaKilicho hiki
client_org_idUuidNdiyoUUIDv7 identifier — sortable by creation time (docs/02 §8).
subscription_idstringHapanaPass 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_codestringHapana
plan_namestringHapana
intervalstringHapana
createdbooleanNdiyoTrue 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_minorintegerHapanaWhat Zinn® charges you per period. `null`, never `0`, when unpriced.
wholesale_currencystringHapana

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 429