Skip to main content
POST
/
subscriptions
/
{subscriptionId}
/
cancel
Cancel a subscription
curl --request POST \
  --url https://api.kelviq.com/api/v1/subscriptions/{subscriptionId}/cancel/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancellationType": "IMMEDIATE",
  "cancellationDate": "2025-12-31"
}
'
{
  "message": "Subscription cancellation processed successfully."
}

Authorizations

​
Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

​
subscriptionId
string<uuid>
required

The unique identifier of the subscription to be cancelled. Example UUID from docs: 78058918-9746-4280-9b9b-1bd5115eec6e

Body

application/json
​
cancellationType
enum<string>
required

Type of cancellation to perform.

Available options:
IMMEDIATE,
CURRENT_PERIOD_ENDS,
SPECIFIC_DATE
Example:

"IMMEDIATE"

​
cancellationDate
string<date> | null

Required if cancellationType is 'SPECIFIC_DATE'. Format: yyyy-MM-dd.

Example:

"2025-12-31"

Response

200 - application/json

Subscription cancellation processed successfully.

​
message
string
Example:

"Subscription cancellation processed successfully."