Skip to main content
POST
Cancel Service
Submit a cancellation for one service in your broker account. Requires admin:full.
A live request starts an immediate-cancellation workflow. The client loses access when cancellation completes. Acceptance alone does not confirm that the service has stopped.

Track the result

HTTP 200 with request_status: "accepted" means the cancellation was accepted for background processing. HTTP 202 with nycservers_review means the request needs NYCServers review. Do not submit a second cancellation. Save the request_id, check List Requests, and check the related service for its current status. If immediate cancellation fails, processing can fall back to an end-of-billing-period request that needs review; the service can remain active. This API action does not send the customer cancellation-confirmation email. See Errors and Retries before repeating a call or choosing an idempotency key.

Endpoint errors

For authentication, permissions, rate limits, and safe retries, see Errors and Retries.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Headers

X-Idempotency-Key
string

Unique key for one intended operation. Reuse with unchanged input for retries. Supported by service creation, plan changes, cancellation, and request approval (not denial). Creation replays by key without checking changed input; action payload conflicts can return 409. See /api/errors-and-retries for endpoint-specific behavior.

Path Parameters

service_number
integer<int64>
required

Public service number parsed as a base-10 integer.

Body

application/json
cancellation_reason
string
required

Nonblank cancellation reason; surrounding whitespace is removed.

Minimum string length: 1

Response

Cancellation accepted for processing.

success
boolean
required
data
object
required
message
string
pagination
object
Last modified on September 8, 2026