compute

DELETE `/v1/certificates/orders/{orderId}`

Cancel an order inside the authority's refund window.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar billing.payment.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

⛔⛔ 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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`orderId (path)`	`Uuid`	Evet	The order's id, as `listCertificateOrders` reports it. Ours (UUIDv7).

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`product_code`	`string`	Evet	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`	Evet	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>`	Evet	⛔⛔ `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`	Evet	The primary domain on the certificate.
`domains`	`string[]`	Evet	Additional names (SANs). Empty for a single-domain product.
`period_years`	`integer`	Evet	—
`price_minor`	`integer`	Evet	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`	Evet	—
`validation_instructions`	`string`	Evet	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`	Evet	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`	Evet	—
`message`	`string`	Evet	Why it failed or was cancelled, in a sentence the customer reads.
`ordered_at`	`string`	Evet	—
`issued_at`	`string`	Evet	—
`expires_at`	`string`	Evet	—
`days_until_expiry`	`integer`	Evet	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`	Evet	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`	Evet	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`	Evet	The order this one renews, so a client can show the chain.
`last_reminded_at`	`string`	Evet	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…

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 429 · 503

DELETE /v1/certificates/orders/{orderId}