Skip to main content
DELETE
/
tax
/
certificate-requests
/
{request_id}
Cancel Certificate Request
curl --request DELETE \
  --url https://api.numeralhq.com/tax/certificate-requests/{request_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Version: <x-api-version>'
{
  "id": "cert_req_b2f1e4a3-9c0d-4e7a-8b1f-2d5a6e7b8c9d",
  "object": "tax.certificate_request",
  "customer": {
    "id": "cust_6126acaf-7379-411a-8ada-00005bac0715",
    "reference_customer_id": "20506"
  },
  "certificate_id": "cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e",
  "certificate_type_id": "US-CA-CDTFA-230",
  "jurisdictions": [
    "US-CA"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "livemode": true
}

​
Cancel Certificate Request (2026-03-01)

Cancel a pending certificate request. Canceling stops reminder emails and removes the request from the customer’s outstanding queue. The endpoint is terminal and idempotent: canceling an already-canceled request returns 200 and the same response body. Canceling a request that has already been fulfilled returns 409 REQUEST_ALREADY_FULFILLED — the caller should retrieve the resulting certificate instead. Canceling a request that’s already in a terminal invalid state returns 409 REQUEST_INVALID.
Remember to include the X-API-Version: 2026-03-01 header. Certificate-request endpoints are live-only — using a sk_test_* key returns TESTMODE_NOT_SUPPORTED. Requests outside your account return CERTIFICATE_REQUEST_NOT_FOUND (404).

​
Response

The full certificate-request object with status: "canceled" — the same shape returned by GET /tax/certificate-requests/{request_id}.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Version
enum<string>
required
Available options:
2026-03-01

Path Parameters

​
request_id
string
required

Response

Canceled certificate request

A single certificate request.

​
id
string
required

The ID of the certificate request

Example:

"cert_req_b2f1e4a3-9c0d-4e7a-8b1f-2d5a6e7b8c9d"

​
object
string
required

The type of object: tax.certificate_request

Example:

"tax.certificate_request"

​
status
enum<string>
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.

Available options:
pending,
fulfilled,
canceled,
invalid
​
customer
object
required

The customer this request is for. null if the underlying buyer record has been removed.

​
certificate_id
string | null
required

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

Example:

"cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e"

​
certificate_type_id
string | null
required

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

Example:

"US-CA-CDTFA-230"

​
jurisdictions
string[]
required

Jurisdiction identifiers covered by the request.

Example:
["US-CA"]
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
expires_at
string<date-time> | null
required

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

​
livemode
enum<boolean>
required

Always true — these endpoints are live-only.

Available options:
true