compute

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

Cancel an order inside the authority's refund window.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 pro…
`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 t…
`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-generate…
`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 `expires_a…
`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 **including the ones it…

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429 · 503

DELETE /v1/certificates/orders/{orderId}