v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Subscriptions

Retrieve cancel survey

Retrieves the cancel survey state for a specific subscriptionId.

If the subscription is active, returns the full list of cancel reasons for display.
If the subscription is already canceled, returns the selected reason, feedback, and language used during cancellation.

get/subscriptions/cancelSurvey/reasons/{subscriptionId}

Path parameters

subscriptionIdstring required

Example:1abc2DE_FGhIjKLm3NoPQR

Unique identifier of the subscription.

Query parameters

lang'ar' | 'cs' | 'da' | 'de' | 'es' | 'fi' | 'fr' | 'hr' | 'hu' | 'it' | 'iw' | 'ja' | 'ko' | 'nl' | 'no' | 'pl' | 'pt' | 'ru' | 'sk' | 'sv' | 'tr' | 'zh'

Example:en

Language code for localization.

Response

Example response

{
  "language": "en",
  "site": "ABC0DE1GHIJ2",
  "subscription": {
    "subscriptionId": "1abc2DE_FGhIjKLm3NoPQR",
    "product": {
      "path": "furious-falcon",
      "displayName": "Furious Falcon"
    }
  },
  "reasons": [
    {
      "id": "6",
      "name": "alternative",
      "displayName": "Alternative",
      "enabled": true,
      "description": "I switched to a different product or needed missing features."
    }
  ]
}