Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/subscriptions \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
The subscriptions in scope — each pins the exact plan version it was sold and carries the **captured** price + entitlements (a purchase-time snapshot, never re-derived from the live catalog, docs/05 §1). Cursor-paginated, RLS-scoped; requires `billing.view`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
X-Zinn-Org (header) | string | Nem | **Which organisation this call acts for.** Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | Nem | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Nem | Maximum items to return (page size). |
status (query) | SubscriptionStatus | Nem | Filter by subscription status. |
org_id (query) | Uuid | Nem | Restrict to one organization in scope. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
data | Subscription[] | Igen | — |
page | PageMeta | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422 · 429