Cancel Subscription
Cancel a subscription
POST
/
api
/
v2
/
subscriptions
/
{id}
/
cancel
Cancel Subscription
curl --request POST \
--url https://api.example.com/api/v2/subscriptions/{id}/cancelimport requests
url = "https://api.example.com/api/v2/subscriptions/{id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v2/subscriptions/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/subscriptions/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/subscriptions/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/subscriptions/{id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/subscriptions/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyCancel Subscription
Cancel a subscription either immediately or at the end of the current billing period.Authentication
Authorization: Bearer glm_test_YOUR_API_KEY
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Subscription ID |
Request Body
{
"cancel_at_period_end": true,
"reason": "customer_request"
}
| Parameter | Type | Required | Description |
|---|---|---|---|
cancel_at_period_end | boolean | No | If true, cancel at period end (default: false) |
reason | string | No | Cancellation reason |
Response
{
"id": "sub_abc123xyz",
"status": "cancelled",
"cancel_at_period_end": true,
"current_period_end": "2025-11-18T14:30:00Z",
"cancelled_at": "2025-10-20T10:00:00Z"
}
Examples
Cancel at Period End
curl -X POST https://api.withgale.com/api/v2/subscriptions/sub_abc123xyz/cancel \
-H "Authorization: Bearer glm_test_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"cancel_at_period_end": true,
"reason": "customer_request"
}'
Immediate Cancellation
curl -X POST https://api.withgale.com/api/v2/subscriptions/sub_abc123xyz/cancel \
-H "Authorization: Bearer glm_test_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"cancel_at_period_end": false
}'
Related Endpoints
โI
Cancel Subscription
curl --request POST \
--url https://api.example.com/api/v2/subscriptions/{id}/cancelimport requests
url = "https://api.example.com/api/v2/subscriptions/{id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v2/subscriptions/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/subscriptions/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/subscriptions/{id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/subscriptions/{id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/subscriptions/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body