compute

DELETE /v1/certificates/orders/{orderId}

Cancel an order inside the authority's refund window.

Све compute крајње тачке

Сва документација за програмере →

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу billing.payment.manage; кључ без ње се одбија уз 403, а не 404.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X DELETE https://api.zinndigital.com/v1/certificates/orders/{orderId} \
  -H "Authorization: Bearer zdk_live_…"

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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).

Одговор

НазивТипОбавезноШта је ово
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
product_codestringДа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_namestringДаWhat the customer reads — the authority's own product name (PositiveSSL, S/MIME Personal, Unified Communications Certificate (UCC)). ⛔ Never a translation key: these are…
statestring<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_namestringДаThe primary domain on the certificate.
domainsstring[]ДаAdditional names (SANs). Empty for a single-domain product.
period_yearsintegerДа—
price_minorintegerДа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.
currencystringДа—
validation_instructionsstringДа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_pemstringДа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_pemstringДа—
messagestringДаWhy it failed or was cancelled, in a sentence the customer reads.
ordered_atstringДа—
issued_atstringДа—
expires_atstringДа—
days_until_expiryintegerДа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…
renewablebooleanДа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_existsbooleanДа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_ofUuidДаThe order this one renews, so a client can show the chain.
last_reminded_atstringДа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