Certificates

Cancel an order that is not issued yet

post/certificates/orders/{orderId}/cancel

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/certificates/orders/{orderId}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

orderIdstring uuid required

Request body

reasonstring required

Response

Canceled

idstring uuid required
organizationIdstring uuid required
productIdstring uuid required
productNamestring required
providerstring required
validation'dv' | 'ov' | 'ev' required
periodMonthsinteger required
amountinteger required
currencystring required
namesstring[] required
dcvMethod'dns' | 'http' | 'email' required
approverEmailstring nullable required
state'draft' | 'awaiting_payment' | 'paid' | 'pending_validation' | 'issued' | 'installed' | 'canceled' | 'refunded' | 'failed' | 'expired' required
paymentStatus'none' | 'pending' | 'paid' | 'refunded' | 'failed' required
paidVia'billing' | 'operator' | 'null' nullable required
paidAtstring nullable required

ISO-8601 timestamp

providerStatusstring nullable required
certificateIdstring uuid nullable required
keyManagedByPlatformboolean required
certificatePemstring nullable required
chainPemstring nullable required
lastErrorstring nullable required
renewalOfstring uuid nullable required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

submittedAtstring nullable required

ISO-8601 timestamp

issuedAtstring nullable required

ISO-8601 timestamp

finishedAtstring nullable required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.