compute
GET /v1/compute/servers/{serverId}/renewal
Read a server's billing contract.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/renewal \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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