compute

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

Cancel an order inside the authority's refund window.

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

API кілтін bearer токені ретінде жіберіңіз. Кілтте billing.payment.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`orderId (path)`	`Uuid`	Иә	The order's id, as `listCertificateOrders` reports it. Ours (UUIDv7).

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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}