compute
DELETE /v1/certificates/orders/{orderId}
Cancel an order inside the authority's refund window.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.payment.manage; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X DELETE https://api.zinndigital.com/v1/certificates/orders/{orderId} \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
⛔⛔ Answers 503 and leaves the order unchanged if the authority cannot be reached. Reporting a cancellation we did not achieve would remove the order from every screen while the charge stands. Requires billing.payment.manage.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
orderId (path) | Uuid | Да | The order's id, as listCertificateOrders reports it. Ours (UUIDv7). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
product_code | string | Да | The stable machine key (positive_ssl). ⛔ Match on this, never on product_name — the name is the certificate authority's marketing string and can be corrected without the… |
product_name | string | Да | What the customer reads — the authority's own product name (PositiveSSL, S/MIME Personal, Unified Communications Certificate (UCC)). ⛔ Never a translation key: these are… |
state | string<pending, awaiting_validation, issued, cancelled, failed, expired> | Да | ⛔⛔ awaiting_validation means PAID AND NOT ISSUED. The authority charges at order time and then waits for the customer to prove they control the domain. It is deliberately… |
common_name | string | Да | The primary domain on the certificate. |
domains | string[] | Да | Additional names (SANs). Empty for a single-domain product. |
period_years | integer | Да | — |
price_minor | integer | Да | What the customer is charged, frozen at order. A copy rather than a join, so an operator repricing the catalogue cannot move an existing bill. |
currency | string | Да | — |
validation_instructions | string | Да | What the customer must still do, in the authority's own words. ⭐ Carried as text rather than parsed: every authority words it differently, and a half-parsed instruction is worse… |
certificate_pem | string | Да | The issued certificate. ⭐ Public by nature — it is served to every visitor of the site — which is why it is returned here while its private key never is: a customer-generated… |
chain_pem | string | Да | — |
message | string | Да | Why it failed or was cancelled, in a sentence the customer reads. |
ordered_at | string | Да | — |
issued_at | string | Да | — |
expires_at | string | Да | — |
days_until_expiry | integer | Да | Whole days until expires_at, negative once it has lapsed. ⛔ null and 0 are DIFFERENT answers and a client must not collapse them: null means we could not read an expiry… |
renewable | boolean | Да | Whether to offer a re-order now — issued, inside the 30-day window, and with no renewal already in flight. ⛔ Computed here rather than left to a client to derive from… |
free_alternative_exists | boolean | Да | Whether Let's Encrypt issues this kind of certificate for nothing. Carried onto the renewal prompt for the same reason it is on the buy screen: say so before asking somebody… |
renewal_of | Uuid | Да | The order this one renews, so a client can show the chain. |
last_reminded_at | string | Да | When the renewal sweep last REACHED this order — which is not the same as when it last emailed about it. ⛔ The sweep stamps this for every row it reaches… |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429 · 503