ავტორიზაცია

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

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

ეს ენდპოინტი იყენებს პარამეტრად org_id. მისი გამოტოვების შემთხვევაში ზარი ფარავს თქვენი იჯარის მთელ ქვეხეს, ხოლო გაგზავნისას ზარი შეიზღუდება მხოლოდ ერთ ორგანიზაციამდე.

თქვენი ორგანიზაციის 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/entitlements \
  -H "Authorization: Bearer zdk_live_…"

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში

დეტალები

The customer-facing half of entitlement enforcement (#2726). Returns every counted allowance the engine refuses on — with used, limit and remaining — and every boolean feature it gates on, marked included or not. A cap the engine refuses on and the customer cannot see is a cap nobody can plan around: the first they learn of it is the moment it stops them. So the numbers here are the same numbers the refusal quotes. limit distinguishes three states (docs/144 §1) and they are not interchangeable: -1 means the plan sold "unlimited" and says so; a non-negative integer is a real cap; null means the plan states no cap at all, which is neither a promise nor a limit and is the normal case — only 8 of 134 live plans state team_seats. enforced is the single field a client should branch on to decide whether to draw a usage bar. Resolution walks the organization tree: a reseller's client org holds no subscription of its own, so the answer comes from the nearest ancestor that grants one, and entitling_org_id names it. Requires billing.view.

პარამეტრები

სახელიტიპისავალდებულორა არის ეს
org_id (query)UuidარაThe organization to report on; defaults to the caller's own.

პასუხი

სახელიტიპისავალდებულორა არის ეს
entitling_org_idUuidდიახThe organization whose plan grants these — the caller's own org or an ancestor. Null when nothing in the chain grants anything.
sourcestring<staff, subscription, none>დიახWhere the grant came from. The customer's next move differs: a staff grant is not upgradable, a subscription one is, and none means there is nothing to upgrade from — buy…
plan_namestringდიახ
has_planbooleanდიახ
allowancesEntitlementAllowance[]დიახ
featuresEntitlementFeature[]დიახ

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

401 · 403 · 429