reseller

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

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

Semua titik akhir reseller

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin reseller.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Endpoint ini menggunakan id organisasi Anda di dalam URL itu sendiri, sebagai orgId. Gantikan ke dalam path — tidak ada header atau parameter kueri yang dapat menggantikannya.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

NamaJenisWajibTentang apa ini
orgId (path)UuidYaOne of your client organizations.
org_id (query)UuidTidakWhich 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)stringTidakISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

Tanggapan

NamaJenisWajibTentang apa ini
client_org_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
subscription_idstringTidakPass 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_codestringTidak
plan_namestringTidak
intervalstringTidak
createdbooleanYaTrue 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_minorintegerTidakWhat Zinn® charges you per period. `null`, never `0`, when unpriced.
wholesale_currencystringTidak

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429