catalog
GET /v1/catalog/plans
List the sellable plans with their prices.
Xác thực
Điểm cuối này là công khai. Nó không yêu cầu thông tin xác thực hay tổ chức nào — đây chính là nội dung mà trang web tiếp thị và các công cụ trả lời bằng AI của chúng tôi đọc.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/catalog/plansĐã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
Returns every active plan with its current version's resolved entitlements (product-line defaults overlaid with the plan's own) and its list prices, in the stored currency and interval. Prices are integer minor units + an ISO currency code (CLAUDE.md §2.8); USD is the base, and a derived, charm-rounded row is served for every enabled currency once the FX refresh has run (docs/29 §2). Public (docs/35 #19). prices is a multi-row array, one entry per (interval, currency) — never a single pre-converted row. A client selects the entry matching the customer's chosen currency AND interval, and must render nothing rather than fall back to an amount in a different currency: a number in the wrong currency, or the right number under the wrong symbol, is worse than an absent price (#471). Each plan carries plan_version_id, the identifier that makes it purchasable. A hosting_plan cart line pins a plan version, not a plan, so before this field existed a customer could browse the catalogue and had no way to buy anything in it (#463). The full self-serve path is POST /v1/carts → POST /v1/carts/{cartId}/lines with {kind: hosting_plan, plan_version_id, metadata: {interval}} → POST /v1/carts/{cartId}/checkout. An internal plan is never listed here and the cart refuses it, so the unlimited staff plan cannot be self-served. Returned whole, not cursor-paginated — a deliberate, documented deviation matching getTranslationBundle: the catalogue is our own bounded content, and a pricing page or the pricing slider needs every tier at once, not 50 at a time. The response is bounded by a hard server-side cap; a catalogue that would exceed it is a 422 (it never silently truncates), which cannot happen with today's catalogue and exists only so unbounded future growth fails loudly. Cacheable exactly like listProductLines (strong ETag + max-age=60).
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
product_line (query) | string | Không | Restrict to one product line by its code (e.g. footprint_free). Unknown code → empty list. |
currency (query) | string | Không | Narrow each plan's prices array to a single ISO 4217 currency. Optional and additive: omitting it returns every currency exactly as before, so no existing client changes… |
If-None-Match (header) | string | Không | A previously returned ETag; a match responds 304. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
data | CatalogPlan[] | Có | — |
Các lỗi điểm cuối này có thể trả về
422 · 429