hosting
GET /v1/sites/{siteId}/plan
List the plans a site could move to, priced.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/plan \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
Every catalogue plan this site could move onto, each already scored against the site, each priced with a prorated quote, and each refusal already applied. A customer who outgrew their package previously had no path at all: the adapter's resize() deliberately raises, pointing at a package-type change that nothing could perform. ⛔ blocked_reason and reason are stable codes, never prose. The engine never sends a sentence a customer reads, because it would be one language on every screen (§2.7); the localised text is the client's. blocked_detail carries the numbers behind usage_exceeds so the screen can say which limit and by how much. Every money figure is an integer in minor units (§2.8) — never a float, never a formatted string — 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. Serves our own fleet as well as the managed shared range (#2271). On the fleet a plan names no vendor package template — the plan is its entitlement set, and applying it is a real setquota on a box we own — so package_type is an empty string there and the package-type refusals (no_package_type, unknown_package_type, platform_mismatch) cannot occur. 404 for a site whose platform has no plan to change, and that set is narrower than "not managed shared": a VPS or cloud server is a machine we hand over where the billed unit is the machine (a resize belongs on the compute seam, and the platform itself refuses a cross-platform package-type change), and an edge host has no account at all. Also 404 for a site that is not the caller's. Requires sites.view and billing.view: this is a price list for the customer's own site, and support needs to see it to answer "what would an upgrade cost".
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
siteId (path) | Uuid | 예 | Site ID (UUIDv7). |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
current | SitePlanOption | 예 | The plan the site is on now. Null when the site's package type matches no plan in our catalogue, which is a real state and not an error. |
options | SitePlanOption[] | 예 | The plans the site could move to, each already scored. |
changeable | boolean | 예 | Whether the surface is open at all for this site. |
reason | string | 예 | Why the whole surface is closed, as a code — subscription_not_live when the governing subscription is cancelled or expired and so is not a sale to change, no_eligible_plan… |
shared_with | integer | 예 | How many sites OTHER than this one draw on the same plan. Retained for clients written against the old refusal, and now derived from coverage.sites so the count and the list… |
coverage | SitePlanCoverage | 예 | The sites this plan covers and the slots they use. Null only when the site has no governing subscription to read. |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 404 · 422 · 429 · 503