Skip to main content
POST
/
api
/
v1
/
workspaces
/
{workspace_id}
/
billing
/
cancel
Cancel Subscription
curl --request POST \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/billing/cancel \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason_text": "<string>",
  "waive_pending_charges": false
}
'
{
  "cancel_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "waived_count": 123,
  "waived_total": 123
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Workspace-Id
string | null

Path Parameters

​
workspace_id
string<uuid>
required

Cookies

​
riftmap_access
string | null

Body

application/json
​
reason
enum<string> | null
Available options:
too_expensive,
missing_feature,
switching_competitor,
no_longer_needed,
other
​
reason_text
string | null
Maximum string length: 500
​
waive_pending_charges
boolean
default:false

Response

Successful Response

​
cancel_at
string<date-time> | null
required
​
status
string
required
​
waived_count
integer | null
​
waived_total
integer | null