compute

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

Cancel an order inside the authority's refund window.

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran billing.payment.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`orderId (path)`	`Uuid`	Ya	The order's id, as `listCertificateOrders` reports it. Ours (UUIDv7).

Respons

Nama	Jenis	Diperlukan	Apakah ia
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`product_code`	`string`	Ya	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 pro…
`product_name`	`string`	Ya	What the customer reads — the authority's own product name (`PositiveSSL`, `S/MIME Personal`, `Unified Communications Certificate (UCC)`). ⛔ Never a translation key: these are t…
`state`	`string<pending, awaiting_validation, issued, cancelled, failed, expired>`	Ya	⛔⛔ `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`	Ya	The primary domain on the certificate.
`domains`	`string[]`	Ya	Additional names (SANs). Empty for a single-domain product.
`period_years`	`integer`	Ya	—
`price_minor`	`integer`	Ya	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`	Ya	—
`validation_instructions`	`string`	Ya	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`	Ya	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-generate…
`chain_pem`	`string`	Ya	—
`message`	`string`	Ya	Why it failed or was cancelled, in a sentence the customer reads.
`ordered_at`	`string`	Ya	—
`issued_at`	`string`	Ya	—
`expires_at`	`string`	Ya	—
`days_until_expiry`	`integer`	Ya	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`	Ya	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 `expires_a…
`free_alternative_exists`	`boolean`	Ya	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`	Ya	The order this one renews, so a client can show the chain.
`last_reminded_at`	`string`	Ya	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 **including the ones it…

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429 · 503

DELETE /v1/certificates/orders/{orderId}