extras

GET `/v1/extra-purchases/{purchaseId}`

Get an extra purchase.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X GET https://api.zinndigital.com/v1/extra-purchases/{purchaseId} \
  -H "Authorization: Bearer zdk_live_…"

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Returns one extra purchase in scope with its status and outcome. Requires `billing.view`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`purchaseId (path)`	`Uuid`	نعم	The extra purchase's id.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`extra_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`object`	لا	—
`domain_id`	`object`	لا	—
`status`	`ExtraPurchaseStatus`	نعم	An extra purchase's lifecycle state.
`category`	`string`	نعم	—
`fulfilment_type`	`ExtraFulfilmentType`	نعم	How an extra is delivered.
`interval`	`ExtraInterval`	نعم	One-off charge or a recurring subscription.
`price`	`MoneyAmount`	نعم	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`recurrence`	`string<none, active, ended>`	نعم	Whether the recurrence behind this purchase is still live. `none` = it never recurred (a one-off); `active` = a scheduled charge exists; `ended` = it recurred and no longer does…
`next_renewal_on`	`object`	لا	The next charge date, or `null`. Also `null` for a live charge that has no date scheduled yet, so read `recurrence` — not this field — to decide whether a purchase renews at all.
`sla_due_at`	`object`	لا	—
`completed_at`	`object`	لا	—
`failure_reason`	`string`	لا	—
`created_at`	`string`	نعم	—
`updated_at`	`string`	نعم	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 429

GET /v1/extra-purchases/{purchaseId}