Skip to main content
POST
/
subscriptions
/
cp
/
api
/
cancellation-retention-offers
/
execute
Execute a configured cancellation retention offer and record the retention activity
curl --request POST \
  --url https://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractId": 123
}
'
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute"

payload = { "contractId": 123 }
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({contractId: 123})
};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({contractId: 123})
};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute",
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([
'contractId' => 123
]),
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://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute"

payload := strings.NewReader("{\n \"contractId\": 123\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))

}
require 'uri'
require 'net/http'

url = URI("https://www.myshop.com/apps/subscriptions/cp/api/cancellation-retention-offers/execute")

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 \"contractId\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "cancellationReason": "<string>",
  "contractId": 123,
  "retentionAction": 123,
  "retentionActionLabel": "<string>",
  "retentionActivity": {
    "activityOn": "2023-11-07T05:31:56Z",
    "additionalInfo": "<string>",
    "cancellationReason": "<string>",
    "contractId": 123,
    "discountApplied": "<string>",
    "id": 123,
    "retentionAction": "<string>",
    "shop": "<string>"
  }
}

Body

application/json
billingAttemptId
integer<int64>
billingInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR,
$UNKNOWN
billingIntervalCount
integer<int32>
cancellationReason
string
compatibleSellingPlanId
string
contractId
integer<int64>
eventSource
enum<string>
Available options:
PAUSE,
CANCELLATION
feedback
string
flowId
integer<int64>
flowReasonId
string
frequencyKey
string
nextBillingDate
string<date-time>
offerTier
string
pauseDurationCycle
integer<int32>
replaceVariantsInfo
object

Product replacement configuration for subscription contracts. Allows replacing existing subscription products with new ones, managing quantities, and handling one-time purchases.

rescheduleFutureOrder
boolean
retentionAction
integer<int32>
sellingPlanId
integer<int64>
shippingAddress
object
skipCycle
integer<int32>

Response

200 - */*

OK

cancellationReason
string
contractId
integer<int64>
eventSource
enum<string>
Available options:
PAUSE,
CANCELLATION
retentionAction
integer<int32>
retentionActionLabel
string
retentionActivity
object