Skip to main content
POST
Cancel Service
Submit a cancellation for one service in your broker account. A successful response means that the API accepted the request, and the service will be cancelled.
This request starts a real cancellation workflow that removes client’s ability to access the service immediately.

Accepted Response

The normal response is HTTP 200. The cancellation continues asynchronously.

Errors

Authorizations

Authorization
string
header
required

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

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 August 2, 2026