GET /v1/subscriptions/{subscriptionId}/plan

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس billing.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

The upgrade/downgrade ladder for a subscription the customer already holds — every purchasable plan on the same product line, priced in their own currency and term, each carrying a prorated quote and each refusal already applied. ⚖️ It exists because a customer asked for it and could not find it. He bought a 50-site plan and wanted more slots; the only thing he could find was the buy flow, which would have sold him a second subscription rather than a bigger one. getSitePlanChoices performs the identical read — but it is addressed by a site, and a customer who has bought slots and not filled any of them has none, so that endpoint was not merely hard to find but unaddressable. ⭐ On a subscription that entitles at least one site whose platform a plan change can act on, this is getSitePlanChoices for that site, verbatim — same service, same refusals, same schema — so the two screens can never disagree about what is for sale. Where it entitles none, the package-type refusals (no_package_type, unknown_package_type, platform_mismatch, different_target) cannot arise, because every one of them is a statement about a site's placement. ⛔ blocked_reason and reason are stable codes, never prose — the localised sentence is the client's, in 58 languages. Every money figure is an integer in minor units, and total_minor and credit_minor are two fields rather than one signed number, because a screen that renders a negative total as a charge is a screen that took money for a refund. coverage names the sites drawing on the plan and the slot arithmetic around them, so an upgrade can say what it will move before the customer commits. Its slots_total and slots_free are nullable and null is not zero: a plan stating no allowance is a different fact from one entitling nothing, and slots_unlimited is the third state. 404 for a subscription in another tenant as well as for one that does not exist — a 403 would confirm that an id belongs to somebody. Requires billing.view: this is a price list for the customer's own subscription, and support needs to see it to answer "what would an upgrade cost".

پیرامیٹرز

جواب

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 422 · 429 · 503