reseller

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

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

सबै reseller इन्डपइन्टहरू

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग reseller.view अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोटले URL मा नै तपाईंको संस्थाको id लाई orgId को रूपमा लिन्छ। यसलाई पथ (path) मा राख्नुहोस् — यसको सट्टामा काम गर्ने कुनै हेडर वा क्वेरी प्यारामिटर छैन।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

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.

प्यारामिटरहरू

नामप्रकारआवश्यकयो के हो
orgId (path)Uuidहुन्छOne of your client organizations.
org_id (query)Uuidहैन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हैनISO 4217 code the wholesale figure is quoted in. Defaults to `USD`.

प्रतिक्रिया

नामप्रकारआवश्यकयो के हो
client_org_idUuidहुन्छUUIDv7 identifier — sortable by creation time (docs/02 §8).
subscription_idstringहैन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_codestringहैन
plan_namestringहैन
intervalstringहैन
createdbooleanहुन्छ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_minorintegerहैनWhat Zinn® charges you per period. `null`, never `0`, when unpriced.
wholesale_currencystringहैन

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404 · 429