compute

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

Cancel an order inside the authority's refund window.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.payment.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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

DELETE /v1/certificates/orders/{orderId}