Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте billing.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде org_id мәнін қабылдайды. Оны бос қалдырсаңыз, шақыру бүкіл жалға алушы тармағын қамтиды; шақыруды бір ұйымға шектеу үшін оны жіберіңіз.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/subscriptions \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
X-Zinn-Org (header) | string | Жоқ | **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 | Жоқ | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Жоқ | Maximum items to return (page size). |
status (query) | SubscriptionStatus | Жоқ | Filter by subscription status. |
org_id (query) | Uuid | Жоқ | Restrict to one organization in scope. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
data | Subscription[] | Иә | — |
page | PageMeta | Иә | — |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 422 · 429