reseller

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

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

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს reseller.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

სwhere your organisation id goes-ის ადგილი

ეს ენდპოინტი იღებს თქვენი ორგანიზაციის ID-ს თავად URL-ში, როგორც orgId. ჩაანაცვლეთ ის მისამართში — არ არსებობს ჰედერი ან ქუერის პარამეტრი, რომელიც ამას შეცვლის.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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_id`	`Uuid`	დიახ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`subscription_id`	`string`	არა	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`	არა	—
`plan_name`	`string`	არა	—
`interval`	`string`	არა	—
`created`	`boolean`	დიახ	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`	არა	What Zinn® charges you per period. `null`, never `0`, when unpriced.
`wholesale_currency`	`string`	არა	—

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 404 · 429

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