Retrieve churn reasons
Last updated: 23-Apr-2026
Rate this article:
Overview
Use the getChurnReasons method to retrieve all the churn reasons for a specific merchant with data in a specific language.
Parameters
| Parameters | Type/Description |
|---|---|
| sessionID | Required (string) |
| Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes. | |
| Language | Required (string) |
| The language abbreviation in which messages are translated. |
Request
<?php
include('Config.php');
// Grab Config Values
$config = new ConfigScripts();
$apiVersion = '6.0';
$i = 1;
$host = 'http://api.avangate.local:8081/rpc/' . $apiVersion . "/";
// Login to get the session id;
$sessionID = $config->rpcLogin($host);
$language = 'en';
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getChurnReasons',
'params' => [$sessionID, $language]
);
$response = $config->callRPC($jsonRpcRequest, $host, true);
print_r(json_encode($response));
?>Response
An array of churn reason objects, made of country code and translation.
[
{
"Code": "CHURN_REASON_NOT_SATISFIED_PRODUCT",
"Translation": "Not satisfied with the product/service"
},
{
"Code": "CHURN_REASON_PREFER_MANUAL",
"Translation": "Prefer to manually renew my subscription"
},
{
"Code": "CUSTOM_REASON_1",
"Translation": "Translation of custom reasons 1"
}
]
Rate this article: