compute

GET /v1/compute/servers/{serverId}/renewal

Read a server's billing contract.

所有 compute 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/renewal \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

When the machine lapses at the provider, when Zinn® charges for it next, what that charge will be, and whether it renews at all. The provider's half is read live on every call rather than served from a stored copy: a cached copy is wrong exactly when somebody has just changed it. renews_at may be "" - that means the provider did not state one, never "never" and never "free". auto_renew, subscription_id, charge_at, price_amount_minor and price_currency are ours, not the provider's, and charge_at rather than renews_at is the date the money moves - see the schema. Requires sites.view.

参数

名称类型必填内容简介
serverId (path)UuidThe server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine.

响应

名称类型必填内容简介
contract_idstringThe provider's contract identifier.
auto_renewbooleanWhether Zinn® will charge for this machine again — Subscription.auto_renew for the subscription that pays for it, reached through the paid order line. It is not the…
subscription_idstringThe subscription whose switch auto_renew reports, to send the customer to POST /v1/subscriptions/{subscriptionId}/auto-renew. "" when the machine was provisioned outside a…
renews_atstringThe provider's date - when the machine lapses at them, as they state it, or "" when they state none. Blank means "not stated" - never "never". It is what the "runs until X,…
charge_atstringZinn®'s date - when the customer's card is charged next, ISO-8601, or "" when the machine has no Zinn® subscription. This is Subscription.current_period_end: the rebill…
price_amount_minorobjectWhat the customer will be charged at charge_at, in integer minor units of price_currency, taken from the subscription's captured price (a live subscriber keeps the price…
price_currencystringThe ISO-4217 code price_amount_minor is denominated in, or "" when there is no subscription. Never rendered apart from the amount, and the amount never without it.
periodstringThe renewal cadence as the provider spells it, or "".

此端点可能返回的错误

401 · 403 · 404 · 422 · 429 · 503