import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.subscriptions.cancel("SUBSCRIPTION_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->subscriptions->cancel('SUBSCRIPTION_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.subscriptions.cancel("SUBSCRIPTION_ID")
curl --request POST \
--url https://api.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"when": "end"
}'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel"
payload := strings.NewReader("{\n \"when\": \"end\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"when\": \"end\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"when\": \"end\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": {
"id": "d5b2ae58-5363-4806-bcaf-7fc939e2c948",
"email": "grace@example.com",
"customerId": null,
"productId": "f463e265-097a-4235-bc2f-5239b19a9874",
"variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
"productName": "Northwind Pro",
"variantName": "1 month",
"quantity": 1,
"price": 9.99,
"currency": "USD",
"every": 1,
"unit": "month",
"status": "cancelling",
"periodEnd": "2026-11-29T16:20:19Z",
"graceEnd": null,
"renewalOrderId": null,
"renewalUrl": null,
"firstOrderId": "bc44febe-0f25-4076-92eb-03a5045a57e7",
"cycles": 1,
"remindedAt": null,
"endedAt": null,
"revoked": false,
"pausedAt": null,
"resumeAt": null,
"pausedBy": null,
"renewsWith": null,
"autoRenews": false,
"chargeTried": 0,
"chargeNextAt": null,
"createdAt": "2026-10-22T16:20:19Z"
},
"meta": {
"history": [
{
"kind": "cancelling",
"detail": "Cancelled by the store. It ends on Nov 29, 2026, when what was paid for runs out.",
"actor": "merchant",
"orderId": null,
"at": "2026-10-22T16:20:19Z"
},
{
"kind": "days",
"detail": "7 free days added by the store. Renews on Nov 29, 2026.",
"actor": "merchant",
"orderId": null,
"at": "2026-10-22T16:20:19Z"
}
],
"orders": [
{
"id": "bc44febe-0f25-4076-92eb-03a5045a57e7",
"status": "completed",
"amount": 9.99,
"currency": "USD",
"renewal": false,
"createdAt": "2026-10-22T16:20:19Z",
"paidAt": "2026-10-22T16:20:19Z"
}
]
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Cancel a subscription
At the end of what was paid for, or straight away. A past due or paused one ends straight away whichever is asked. A renewal waiting to be paid is cancelled. Whatever the store lets its buyers do, the store may always cancel. The subscription as data, with meta.history (what happened to it, newest first) and meta.orders (its first order and every renewal).
Needs the subscriptions.write permission (Change Subscriptions).
import Shoply from "@shoplygg/node";
const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });
const result = await shoply.subscriptions.cancel("SUBSCRIPTION_ID");<?php
require 'vendor/autoload.php';
$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);
$result = $shoply->subscriptions->cancel('SUBSCRIPTION_ID');
import shoply
client = shoply.Client() # reads SHOPLY_API_KEY
result = client.subscriptions.cancel("SUBSCRIPTION_ID")
curl --request POST \
--url https://api.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"when": "end"
}'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel"
payload := strings.NewReader("{\n \"when\": \"end\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"when\": \"end\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoply.gg/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"when\": \"end\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": null,
"code": null,
"data": {
"id": "d5b2ae58-5363-4806-bcaf-7fc939e2c948",
"email": "grace@example.com",
"customerId": null,
"productId": "f463e265-097a-4235-bc2f-5239b19a9874",
"variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
"productName": "Northwind Pro",
"variantName": "1 month",
"quantity": 1,
"price": 9.99,
"currency": "USD",
"every": 1,
"unit": "month",
"status": "cancelling",
"periodEnd": "2026-11-29T16:20:19Z",
"graceEnd": null,
"renewalOrderId": null,
"renewalUrl": null,
"firstOrderId": "bc44febe-0f25-4076-92eb-03a5045a57e7",
"cycles": 1,
"remindedAt": null,
"endedAt": null,
"revoked": false,
"pausedAt": null,
"resumeAt": null,
"pausedBy": null,
"renewsWith": null,
"autoRenews": false,
"chargeTried": 0,
"chargeNextAt": null,
"createdAt": "2026-10-22T16:20:19Z"
},
"meta": {
"history": [
{
"kind": "cancelling",
"detail": "Cancelled by the store. It ends on Nov 29, 2026, when what was paid for runs out.",
"actor": "merchant",
"orderId": null,
"at": "2026-10-22T16:20:19Z"
},
{
"kind": "days",
"detail": "7 free days added by the store. Renews on Nov 29, 2026.",
"actor": "merchant",
"orderId": null,
"at": "2026-10-22T16:20:19Z"
}
],
"orders": [
{
"id": "bc44febe-0f25-4076-92eb-03a5045a57e7",
"status": "completed",
"amount": 9.99,
"currency": "USD",
"renewal": false,
"createdAt": "2026-10-22T16:20:19Z",
"paidAt": "2026-10-22T16:20:19Z"
}
]
}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}{
"success": false,
"message": "<string>",
"code": "<string>",
"data": null,
"errors": {}
}Authorizations
A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...
Headers
A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.
Path Parameters
The store's ID. A key reaches the store it was made in: GET /key answers which.
The subscription.
Body
When it ends.
end, now 
