Skip to main content

Cancel Subscription

Cancel a specific existing subscription payment

POST https://api.spotflow.co/api/v1/subscriptions/:subscription-id/cancel

Headers

authorization
String

Bearer SECRET_KEY
Include your secret key in the request header as a Bearer token for authorization. Unauthorized requests will result in a 401 HTTP status code.

Path Parameters

subscription-id int32

This is the unique ID of the subscription you want to cancel

Sample Response

200 OK

{
"id": "2cf2d1de-9c36-4b62-84b4-c1bccd7294bc",
"customerId": "aec7a027-e587-49f8-986e-1765fb8b2d10",
"planId": "b99cf70b-3a86-43cc-b868-140c97c6c9f6",
"status": "cancelled",
"startDate": "2025-04-16T10:44:10Z",
"nextPaymentDate": "2025-04-16T10:45:10Z",
"createdAt": "2025-04-16T10:44:10Z",
"metadata": {
"title": "Creator",
"productName": "Gab"
},
"currency": "NGN",
"regionName": "Nigeria",
"amount": 100
}