Enter campaign

Use the enterChurnCampaign method to confirm the campaign you want for the churn campaign process.

Request parameters

Parameter	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.
SubscriptionReference	Required (string) Unique, system-generated subscription identifier.
CampaignCode	Required (string) The code of the campaign you want to confirm.
EnterCampaignStep	Object
EnterCapaignStep.Step	Required (string) Can have one of the following values: TEXT, REASON, DISPLAY, PAUSE.
EnterCapaignStep.Success	Required (Integer) Indicates whether the user continued through the cancellation flow or chose to keep the subscription at this step. 0 – The user continued the cancellation process after this step (e.g., clicked Next, did not exit). 1 – The user interrupted the flow and chose to keep the subscription active (e.g., closed the wizard, clicked Keep my subscription). A value of 1 signifies that the cancellation process has ended early, and no further steps will follow.
EnterCapaignStep.Reason	String, nullable Designed for the REASON step. It’s the reason why the user wants to stop the auto renewal for the subscription. It should be one of the churn reasons managed by the merchant in the 2Checkout platform.
EnterCapaignStep.Comment	String, nullable Designed for the REASON step. It’s an additional field for the user to explain the reason better.

Request sample

example.php

<?php

require('PATH_TO_AUTH');

$subscriptionReference = '351D8F557E';
$campaignCode          = 'UGPPKKJY5L1LHBFPHKQ3';
$enterCampaignStep = new stdClass();
$enterCampaignStep->Step = “REASON”;
$enterCampaignStep->Success = 0;
$enterCampaignStep->Reason = “CHURN_REASON_NOT_SATISFIED”;
$enterCampaignStep->Comment = “Not statisfied because …”;


$jsonRpcRequest = [\
    'method' => 'enterChurnCampaign',\
    'params' => [$sessionID, $subscriptionReference, $campaignCode, $enterCampaignStep],\
    'id' => $i++,\
    'jsonrpc' => '2.0'\
];

var_dump(callRPC((object)$jsonRpcRequest, $host, true));

Response parameters

Type	Description
Boolean	true or false depending on whether the changes were successful or not.