Cancel a subscription
Cancels an active subscription for a customer.
Authorizations
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
The unique identifier of the subscription to be cancelled. Example UUID from docs: 78058918-9746-4280-9b9b-1bd5115eec6e
Body
Type of cancellation to perform.
IMMEDIATE, CURRENT_PERIOD_ENDS, SPECIFIC_DATE "IMMEDIATE"
Required if cancellationType is 'SPECIFIC_DATE'. Format: yyyy-MM-dd.
"2025-12-31"
Optional structured feedback explaining why the subscription is being cancelled.
TOO_EXPENSIVE, MISSING_FEATURES, SWITCHED_SERVICE, UNUSED, CUSTOMER_SERVICE, LOW_QUALITY, TOO_COMPLEX, OTHER "TOO_EXPENSIVE"
Optional free-form cancellation comment.
"The plan no longer fits our budget."
Response
Subscription cancellation processed successfully.
"Subscription cancellation processed successfully."