compute
GET /v1/compute/servers/{serverId}/renewal
Read a server's billing contract.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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) | Uuid | はい | The 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_id | string | はい | The provider's contract identifier. |
auto_renew | boolean | はい | Whether 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_id | string | はい | The 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_at | string | はい | The 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_at | string | はい | Zinn®'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_minor | object | はい | What 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_currency | string | はい | The 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. |
period | string | はい | The renewal cadence as the provider spells it, or "". |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503