Membership Contracts
Get pending downgrade for a membership contract
Retrieves the pending/scheduled downgrade details for a specific membership contract. This endpoint returns information about a downgrade that has been scheduled but not yet executed.
Response Information:
- contractId: The membership contract ID
- waitTillTimestamp: When the downgrade will be executed
- oldVariantId: The current product variant ID
- newVariantId: The target product variant ID after downgrade
- oldPrice: Current membership price
- newPrice: New price after downgrade
- sellingPlanId: The selling plan ID for the new membership
- sellingPlanName: Name of the selling plan
Use Cases:
- Check if a customer has a pending downgrade scheduled
- Display pending downgrade information in custom dashboards
- Verify downgrade details before allowing further modifications
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
GET
/
api
/
external
/
v2
/
subscription-contract-details
/
{contractId}
/
pending-downgrade
Get pending downgrade for a membership contract
curl --request GET \
--url https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgradeimport requests
url = "https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade';
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://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade",
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://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade"
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://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade")
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{
"contractId": 123,
"customerId": 123,
"eventSource": "<string>",
"executionArn": "<string>",
"newCustomerTag": "<string>",
"newOrderTag": "<string>",
"newPrice": 123,
"newVariantId": "<string>",
"oldCustomerTags": "<string>",
"oldLineId": "<string>",
"oldPrice": 123,
"oldVariantId": "<string>",
"retryCount": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"shop": "<string>",
"waitTillTimestamp": "<string>"
}{
"contractId": 123,
"customerId": 123,
"eventSource": "<string>",
"executionArn": "<string>",
"newCustomerTag": "<string>",
"newOrderTag": "<string>",
"newPrice": 123,
"newVariantId": "<string>",
"oldCustomerTags": "<string>",
"oldLineId": "<string>",
"oldPrice": 123,
"oldVariantId": "<string>",
"retryCount": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"shop": "<string>",
"waitTillTimestamp": "<string>"
}{
"contractId": 123,
"customerId": 123,
"eventSource": "<string>",
"executionArn": "<string>",
"newCustomerTag": "<string>",
"newOrderTag": "<string>",
"newPrice": 123,
"newVariantId": "<string>",
"oldCustomerTags": "<string>",
"oldLineId": "<string>",
"oldPrice": 123,
"oldVariantId": "<string>",
"retryCount": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"shop": "<string>",
"waitTillTimestamp": "<string>"
}Headers
Path Parameters
The membership contract ID
Query Parameters
API Key (Deprecated - Use Header X-API-Key instead)
Response
Pending downgrade found and returned successfully
⌘I
Get pending downgrade for a membership contract
curl --request GET \
--url https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgradeimport requests
url = "https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade';
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://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade",
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://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade"
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://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade")
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{
"contractId": 123,
"customerId": 123,
"eventSource": "<string>",
"executionArn": "<string>",
"newCustomerTag": "<string>",
"newOrderTag": "<string>",
"newPrice": 123,
"newVariantId": "<string>",
"oldCustomerTags": "<string>",
"oldLineId": "<string>",
"oldPrice": 123,
"oldVariantId": "<string>",
"retryCount": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"shop": "<string>",
"waitTillTimestamp": "<string>"
}{
"contractId": 123,
"customerId": 123,
"eventSource": "<string>",
"executionArn": "<string>",
"newCustomerTag": "<string>",
"newOrderTag": "<string>",
"newPrice": 123,
"newVariantId": "<string>",
"oldCustomerTags": "<string>",
"oldLineId": "<string>",
"oldPrice": 123,
"oldVariantId": "<string>",
"retryCount": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"shop": "<string>",
"waitTillTimestamp": "<string>"
}{
"contractId": 123,
"customerId": 123,
"eventSource": "<string>",
"executionArn": "<string>",
"newCustomerTag": "<string>",
"newOrderTag": "<string>",
"newPrice": 123,
"newVariantId": "<string>",
"oldCustomerTags": "<string>",
"oldLineId": "<string>",
"oldPrice": 123,
"oldVariantId": "<string>",
"retryCount": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"shop": "<string>",
"waitTillTimestamp": "<string>"
}