Get pending downgrade for a subscription contract

Retrieves the pending/scheduled downgrade details for a specific subscription contract. This endpoint returns information about a downgrade that has been scheduled but not yet executed.

Full behavior, validation rules, and side effects

Response Information:

• contractId: The subscription 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 subscription price
• newPrice: New price after downgrade
• sellingPlanId: The selling plan ID for the new subscription
• 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 subscription contract

cURL

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-details/{contractId}/pending-downgrade

200

{
  "shop": "<string>",
  "contractId": 123,
  "waitTillTimestamp": "<string>",
  "oldLineId": "<string>",
  "oldVariantId": "<string>",
  "newVariantId": "<string>",
  "sellingPlanId": "<string>",
  "sellingPlanName": "<string>",
  "oldPrice": 123,
  "newPrice": 123,
  "newCustomerTag": "<string>",
  "oldCustomerTags": "<string>",
  "newOrderTag": "<string>",
  "eventSource": "<string>",
  "retryCount": 123,
  "customerId": 123,
  "executionArn": "<string>"
}

Headers

X-API-Key · string

Path Parameters

contractId · integer<int64> · required

The subscription contract ID

Query Parameters

api_key · string

API Key (Deprecated - Use Header X-API-Key instead)

Response

200

application/json

Pending downgrade found and returned successfully

shop · string

contractId · integer<int64>

waitTillTimestamp · string

oldLineId · string

oldVariantId · string

newVariantId · string

sellingPlanId · string

sellingPlanName · string

oldPrice · number<double>

newPrice · number<double>

newCustomerTag · string

oldCustomerTags · string

newOrderTag · string

eventSource · string

retryCount · integer<int32>

customerId · integer<int64>

executionArn · string