Skip to main content
POST
/
v1
/
sdk
/
purchases
/
{purchaseRef}
/
cancel
Cancel a purchase
curl --request POST \
  --url https://api.example.com/v1/sdk/purchases/{purchaseRef}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
import requests

url = "https://api.example.com/v1/sdk/purchases/{purchaseRef}/cancel"

payload = { "reason": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.example.com/v1/sdk/purchases/{purchaseRef}/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/v1/sdk/purchases/{purchaseRef}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/sdk/purchases/{purchaseRef}/cancel"

payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

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.example.com/v1/sdk/purchases/{purchaseRef}/cancel")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/sdk/purchases/{purchaseRef}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "purchase": {
    "amount": 9900,
    "createdAt": "<string>",
    "currency": "GBP",
    "customerEmail": "customer@example.com",
    "customerRef": "cus_3C4D5E6F",
    "isRecurring": true,
    "productRef": "prd_1A2B3C4D",
    "reference": "pur_1A2B3C4D",
    "startDate": "<string>",
    "status": "active",
    "autoRenew": true,
    "cancellationReason": "<string>",
    "cancelledAt": "<string>",
    "endDate": "<string>",
    "exchangeRate": 1.3082,
    "metadata": {},
    "nextBillingDate": "<string>",
    "originalAmount": 10000,
    "paidAt": "<string>",
    "planSnapshot": {
      "currency": "USD",
      "planType": "recurring",
      "price": 2999,
      "billingCycle": "monthly",
      "creditsPerUnit": 1,
      "features": {},
      "freeUnits": 100,
      "limit": 5000,
      "limits": {},
      "meterRef": "mtr_1A2B3C4D",
      "name": "Pro Monthly",
      "reference": "pln_1A2B3C4D"
    },
    "productName": "API Gateway Manager",
    "usage": {
      "overageCost": 0,
      "overageUnits": 0,
      "used": 150,
      "periodEnd": "2025-11-01T00:00:00Z",
      "periodStart": "2025-10-01T00:00:00Z"
    }
  },
  "success": true
}

Path Parameters

purchaseRef
string
required

Purchase reference or ID

Example:

"pur_1A2B3C4D"

Body

application/json
reason
string

Response

Purchase cancelled successfully

purchase
object
success
boolean