Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26286592.7 KB

Cancel Certificate Request

Cancel a pending certificate request. Terminal and idempotent — canceling an already-canceled request returns 200 with the same body. Canceling a fulfilled request returns 409 with REQUEST_ALREADY_FULFILLED. Live-only.

delete/tax/certificate-requests/{request_id}

Path parameters

request_idstring required

Headers

X-API-Version'2026-03-01' required

Response

Canceled certificate request

idstring required

The ID of the certificate request

objectstring required

The type of object: tax.certificate_request

status'pending' | 'fulfilled' | 'canceled' | 'invalid' required

Public lifecycle state of a certificate request. The internal status enum is narrower in the public vocabulary on purpose — processing collapses to pending, failed collapses to invalid.

certificate_idstring nullable required

Populated only when status === "fulfilled". The cert_* id of the submitted certificate.

certificate_type_idstring nullable required

Stable identifier of the requested certificate type, e.g. US-CA-CDTFA-230.

jurisdictionsstring[] required

Jurisdiction identifiers covered by the request.

created_atstring date-time required
updated_atstring date-time required
expires_atstring date-time nullable required

When the request will auto-expire if not fulfilled. null if the request does not auto-expire.

livemodetrue required

Always true — these endpoints are live-only.

Example response

{
  "id": "cert_req_b2f1e4a3-9c0d-4e7a-8b1f-2d5a6e7b8c9d",
  "object": "tax.certificate_request",
  "customer": {
    "id": "cust_6126acaf-7379-411a-8ada-00005bac0715",
    "reference_customer_id": "20506",
    "name": "Acme Co"
  },
  "linked_buyer": {
    "id": "12345",
    "legal_name": "Acme Co"
  },
  "certificate_id": "cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e",
  "certificate_type_id": "US-CA-CDTFA-230",
  "jurisdictions": [
    "US-CA"
  ]
}