Skip to main content
GET
/
subscriptions
/
cp
/
api
/
cancellation-managements
/
{id}
Get cancellation management configuration
curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/cancellation-managements/{id}
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/cancellation-managements/{id}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/cancellation-managements/{id}', 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-managements/{id}';
const options = {method: 'GET'};

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-managements/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://www.myshop.com/apps/subscriptions/cp/api/cancellation-managements/{id}"

req, _ := http.NewRequest("GET", url, nil)

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-managements/{id}")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "shop": "<string>",
  "cancellationInstructionsText": "<string>",
  "cancellationReasonsJSON": "<string>",
  "discountEmailAddress": "<string>",
  "dynamicallyPauseCycleOnCancellation": true,
  "enableDiscountEmail": true,
  "id": 123,
  "pauseDurationCycle": 123,
  "pauseInstructionsText": "<string>",
  "pauseReasonsJSON": "<string>"
}

Path Parameters

id
integer<int64>
required

Response

200 - */*

OK

shop
string
required
cancellationInstructionsText
string
cancellationReasonsJSON
string
cancellationType
enum<string>
Available options:
CANCEL_IMMEDIATELY,
CANCELLATION_INSTRUCTIONS,
CUSTOMER_RETENTION_FLOW,
CANCEL_AFTER_PAUSE
discountEmailAddress
string
dynamicallyPauseCycleOnCancellation
boolean
enableDiscountEmail
boolean
id
integer<int64>
pauseDurationCycle
integer<int32>
pauseInstructionsText
string
pauseReasonsJSON
string
pauseType
enum<string>
Available options:
PAUSE_IMMEDIATELY,
PAUSE_INSTRUCTIONS,
CUSTOMER_RETENTION_FLOW