| Verifone Developer Portal

Renewal Performance Report

Overview

The renewal performance report provides a comprehensive view of how subscription renewals and expirations occur within a specific period, enabling you to measure retention performance accurately, understand churn drivers, and identify potential churn-risk behaviors.

The report includes key productivity metrics, such as renewal rate, cancellation rate, and disabling auto-renewal events, alongside visual breakdowns of subscription status changes over time.

This report supports data-driven analysis of the subscription lifecycle.

Benefits

Subscription businesses need clear indicators of subscriber engagement and churn potential. The renewal performance report enables you to:

Track how many subscriptions are renewed vs. expired in a selected interval

Monitor customer behaviors related to automated and manual renewals

Detect early churn risk through auto-renewal disablement patterns

Understand the distribution of subscription outcomes over time for effective strategy planning

Report components

Filters

Configure the following filters to tailor the report output:

Subscription expiration date range - choose the interval for which expiring subscriptions’ renewals should be evaluated

expiration date

Initial purchase date - restrict reporting to subscriptions created within the specified interval

Product - contains product name and product code grouped, enabling precise filtering of the results to one or more products

Billing country - view metrics for subscriptions based on country

Billing cycle length - filter results by subscription term duration

Payment method - filter results by payment method (examples: Visa, Carte Bleue, PayPal, etc.)

payment method

Renewal type - segment results by automatic or manual renewal

Partner/test subscription flags - include or exclude partner/test subscriptions from the analysis

Metric cards

At the top of the report, three metric cards display key performance indicators that provide a high-level subscription health status during the reporting period.

Renewal Rate - percentage of subscriptions that are renewed successfully out of all subscriptions expiring in the selected period.

Cancellation Rate - percentage of subscriptions that don't renew and become expired or disabled.

Disabling auto-renewal events - percentage of active subscriptions for which auto-renewal is turned off before the renewal date, indicating potential churn risk.

Each card shows absolute counts, percentage values, and comparisons to previous intervals or the same period in prior years to track trend movements.

Renewal & expiration events chart

A stacked bar chart displays:

Daily/weekly/monthly counts of subscription renewal status events throughout the reporting interval

Each colored segment corresponds to one subscription renewal status category

Provides a visual timeline of how renewals and expirations occurred

chart

Subscription renewal statuses

Each bar in the renewal and expiration events chart corresponds to these renewal statuses:

Automatically renewed - subscriptions that successfully renewed via auto-billing around their scheduled renewal date

Manually renewed - subscriptions that were renewed through manual customer action

Active but unrenewed - subscriptions with expiration dates within the selected period where renewal hasn’t occurred yet

Disabled - subscriptions deactivated before renewal through a disable action

Expired - subscriptions whose grace period expired without renewal and are now inactive

Past due - subscriptions past the expiration date but still in grace period; payment retries may still recover renewal in case of auto-renewing subscriptions, or shopper action may still trigger manual renewal

How to interpret the report

High renewal rate signals strong subscriber engagement and product satisfaction

Rising cancellation or disabling events at scale may uncover issues with pricing, value perception, or communication

Active but unrenewed subscriptions suggest timing effects where renewals may still occur

Past due volume helps evaluate payment processing performance and retry effectiveness

Update order reseller information

Overview

Use this method to update the reseller information defined for a specific order.

Parameters

Parameter	Type/Description
sessionID	Required (string)
	Session identifier, which is the output of the Login method. An exception will be thrown if the values are incorrect.
PartnerCode	Required (string)
	Unique identifier that you need to specify when creating a partner in the Control Panel. You can find it under the General Information area when editing partner details
ResellerCode	Required (string)
	Unique, system generated reseller identifier.
OrderRefNo	Required (string)
	The unique, system-generated identifier of a partner order.

Request

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'MERCHANT';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/soap/6.0';
    public const ACTION = 'updateOrderReseller';
    //array or JSON
    public const PAYLOAD = <<<JSON
{
    "PartnerCode": "Test Avangate",
    "ResellerCode": "DB6F1A946E",
    "OrderRefNo": 731522351
}
JSON;

}
class Client
{
    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?object {
        if (is_array($payload)) {
            $payload = json_encode($payload);
        }
        if (!empty($payload)) {
            // SoapClient works with objects(StdClass)
            $payload = json_decode($payload);
        }
        $soapClient = $this->getClient($url);
        $sessionId = $this->getSession($soapClient);
        $args = array_filter([$sessionId, $payload]);
        return $soapClient->$action(...$args);
    }

    public function getClient(string $url): SoapClient
    {
        return new SoapClient(
            $url.'?wsdl',
            [
                'location' => $url,
                'cache_wsdl' => WSDL_CACHE_NONE,
            ]
        );
    }

    public function getSession(SoapClient $client)
    {
        $date = gmdate('Y-m-d H:i:s');
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $string = strlen($merchantCode).$merchantCode.strlen($date).$date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);
        $client->__setCookie('XDEBUG_SESSION', 'PHPSTORM');
        return $client->login($merchantCode, $date, $hash, $algo);
    }
}
try {
    $client = new Client();
    var_dump($client->call());
} catch (Exception $ex) {
    var_dump($ex);
}

Errors

Error	Description
Missing required parameter: PartnerCode	Add the PartnerCode parameter.
Missing required parameter: ResellerCode	Add the ResellerCode parameter.
Missing required parameter: OrderRefNo	Add the OrderRefNo parameter.
INVALID_ID_SALE	Invalid order reference.

Retrieve partner reseller list

Overview

Use this method to retrieve a list of resellers defined and stored for one of your partners.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, which is the output of the Login method. An exception will be thrown if the values are incorrect.
partnerCode	Required (string)
	Unique identifier that you need to specify when creating a partner in the Control Panel. You can find it under the General Information area when editing partner details.
searchBy	Array (optional)
	Control the pagination of results using the parameters Page and Limit. If they are not provided, the default values will be displayed: Page 1, Limit 10.

Request

<?php
declare(strict_types=1);
class Configuration
{
    public const MERCHANT_CODE = 'MERCHANT';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/soap/6.0';
    public const ACTION = 'getPartnerResellers';

    public const PAYLOAD = <<<JSON
{
    "PartnerCode": "Test Avangate",
    "SearchBy": {
        "Page": 1,
        "Limit": 150
    }
}
JSON;

}
class Client
{
    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?object {
        if (is_array($payload)) {
            $payload = json_encode($payload);
        }
        if (!empty($payload)) {
            // SoapClient works with objects(StdClass)
            $payload = json_decode($payload);
        }
        $soapClient = $this->getClient($url);
        $sessionId = $this->getSession($soapClient);
        $args = array_filter([$sessionId, $payload]);
        return $soapClient->$action(...$args);
    }

    public function getClient(string $url): SoapClient
    {
        return new SoapClient(
            $url.'?wsdl',
            [
                'location' => $url,
                'cache_wsdl' => WSDL_CACHE_NONE,
            ]
        );
    }

    public function getSession(SoapClient $client)
    {
        $date = gmdate('Y-m-d H:i:s');
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $string = strlen($merchantCode).$merchantCode.strlen($date).$date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);
        $client->__setCookie('XDEBUG_SESSION', 'PHPSTORM');
        return $client->login($merchantCode, $date, $hash, $algo);
    }
}
try {
    $client = new Client();
    var_dump($client->call());
} catch (Exception $ex) {
    var_dump($ex);
}

Response

Parameter	Type/Description
Reseller	Array of reseller objects.

Errors

Error	Description
MISSING_PARAMETER	Add the PartnerCode paramater in the request before calling this method.

Update reseller information

Overview

Use this method to update the details for an existing reseller entity in the Avangate platform.

Parameters

Parameter	Type/Description
sessionID	Required (string)
	Session identifier, which is the output of the Login method. An exception will be thrown if the values are incorrect.
Reseller	Required (object)

Response

Parameter	Type/Description
Result	Boolean

Request

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'MERCHANT';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/soap/6.0';
    public const ACTION = 'updateReseller';
    //array or JSON
    public const PAYLOAD = <<<JSON
{
    "PartnerCode": "Test Avangate",
    "ResellerCode": "Q6WSZXXAA7",
    "FirstName": "test",
    "LastName": "test",
    "Company": "Test Partner 44",
    "Email": "test1111@example.com",
    "Address": "a4126f5939",
    "City": "bbbb",
    "PostalCode": "4acbc843c0",
    "Country": "RO",
    "State": "kkk",
    "Phone": "kkk",
    "Fax": "gfgdfg"
}
JSON;

}
class Client
{
    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?object {
        if (is_array($payload)) {
            $payload = json_encode($payload);
        }
        if (!empty($payload)) {
            // SoapClient works with objects(StdClass)
            $payload = json_decode($payload);
        }
        $soapClient = $this->getClient($url);
        $sessionId = $this->getSession($soapClient);
        $args = array_filter([$sessionId, $payload]);
        return $soapClient->$action(...$args);
    }

    public function getClient(string $url): SoapClient
    {
        return new SoapClient(
            $url.'?wsdl',
            [
                'location' => $url,
                'cache_wsdl' => WSDL_CACHE_NONE,
            ]
        );
    }

    public function getSession(SoapClient $client)
    {
        $date = gmdate('Y-m-d H:i:s');
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $string = strlen($merchantCode).$merchantCode.strlen($date).$date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);
        $client->__setCookie('XDEBUG_SESSION', 'PHPSTORM');
        return $client->login($merchantCode, $date, $hash, $algo);
    }
}
try {
    $client = new Client();
    var_dump($client->call());
} catch (Exception $ex) {
    var_dump($ex);
}

Reseller

Structure

Reseller	Object
PartnerCode	String (required)
	Unique identifier that you need to specify when creating a partner in the Control Panel. You can find it under the General Information area when editing partner details
ResellerCode	String (required)
	Unique, system generated reseller identifier.
Company	String (required)
	Reseller company name.
FirstName	String (required)
	Reseller first name.
LastName	String (required)
	Reseller last name.
Email	String (required)
	Reseller email. Can be NULL.
Phone	String
	Reseller phone. Can be NULL.
Fax	String
	Reseller fax. Can be NULL.
Country	String (required)
	Reseller country ISO language code (ISO 639-1 two-letter code).
State	String
	Reseller state. For example, "Alabama","Alaska","Arizona". Can be NULL.
City	String
	Reseller city. Can be NULL.
Address	String
	Reseller address. Can be NULL.
PostalCode	String
	Reseller ZIP code. Can be NULL.

Update order reseller information

Overview

Use this method to update the reseller information defined for a specific order.

Parameters

Parameter	Type/Description
PartnerCode	Required (string)
	Unique identifier that you need to specify when creating a partner in the Control Panel. You can find it under the General Information area when editing partner details
ResellerCode	Required (string)
	Unique, system generated reseller identifier.
OrderRefNo	Required (string)
	The unique, system-generated identifier of a partner order.

Request

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'MERCHANT';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.local/rpc/6.0';
    public const ACTION = 'updateOrderReseller';
    //array or JSON
    public const PAYLOAD = <<<JSON
{
    "PartnerCode": "Test Avangate",
    "ResellerCode": "DB6F1A946E",
    "OrderRefNo": 731522351
}
JSON;

}

class Client
{
    private const LOGIN_METHOD = 'login';
    private $calls = 1;
    private $sessionId;

    private function generateAuth(): array
    {
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $date = gmdate('Y-m-d H:i:s');
        $string = strlen($merchantCode) . $merchantCode . strlen($date) . $date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);

        return compact('merchantCode', 'date', 'hash', 'algo');
    }

    public function login(string $url)
    {
        $payload = $this->generateAuth();
        $response = $this->call($url, array_values($payload), self::LOGIN_METHOD);
        $this->sessionId = $response['result'];
    }

    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?array {
        if (empty($this->sessionId) && $action !== self::LOGIN_METHOD) {
            $this->login($url);
        }
        if (is_string($payload)) {
            $payload = json_decode($payload, true);
        }
        if (!empty($this->sessionId)) {
            $payload = [$this->sessionId, $payload];
        }
        $payload = array_filter($payload);
        $request = json_encode([
            'jsonrpc' => '2.0',
            'method'  => $action,
            'params'  => $payload,
            'id'      => $this->calls++,
        ]);
        $curl = curl_init($url);
        curl_setopt($curl, CURLOPT_POST, 1);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
        curl_setopt($curl, CURLOPT_SSLVERSION, 0);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt(
            $curl,
            CURLOPT_HTTPHEADER,
            ['Content-Type: application/json', 'Accept: application/json', 'Cookie: XDEBUG_SESSION=PHPSTORM']
        );
        curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
        $response = curl_exec($curl);
        if (empty($response)) {
            die('Server unavailable');
        }
        echo $response . '</br>';

        return json_decode($response, true);;
    }
}

$client = new Client();
$result = $client->call();
var_dump($result);

Errors

Error	Description
Missing required parameter: PartnerCode	Add the PartnerCode parameter.
Missing required parameter: ResellerCode	Add the ResellerCode parameter.
Missing required parameter: OrderRefNo	Add the OrderRefNo parameter.
INVALID_ID_SALE	Invalid order reference.

Retrieve partner reseller list

Overview

Use this method to retrieve a list of resellers defined and stored for one of your partners.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, which is the output of the Login method. An exception will be thrown if the values are incorrect.
partnerCode	Required (string)
	Unique identifier that you need to specify when creating a partner in the Control Panel. You can find it under the General Information area when editing partner details.
searchBy	Array (optional)
	Control the pagination of results using the parameters Page and Limit. If they are not provided, the default values will be displayed: Page 1, Limit 10.

Request

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'MERCHANT';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/rpc/6.0';
    public const ACTION = 'getPartnerResellers';
    //array or JSON
    public const PAYLOAD = <<<JSON
{
    "PartnerCode": "Test Avangate",
    "SearchBy": {
        "Page": 1,
        "Limit": 150
    }
}
JSON;

}

class Client
{
    private const LOGIN_METHOD = 'login';
    private $calls = 1;
    private $sessionId;

    private function generateAuth(): array
    {
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $date = gmdate('Y-m-d H:i:s');
        $string = strlen($merchantCode) . $merchantCode . strlen($date) . $date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);

        return compact('merchantCode', 'date', 'hash', 'algo');
    }

    public function login(string $url)
    {
        $payload = $this->generateAuth();
        $response = $this->call($url, array_values($payload), self::LOGIN_METHOD);
        $this->sessionId = $response['result'];
    }

    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?array {
        if (empty($this->sessionId) && $action !== self::LOGIN_METHOD) {
            $this->login($url);
        }
        if (is_string($payload)) {
            $payload = json_decode($payload, true);
        }
        if (!empty($this->sessionId)) {
            $payload = [$this->sessionId, $payload];
        }
        $payload = array_filter($payload);
        $request = json_encode([
            'jsonrpc' => '2.0',
            'method'  => $action,
            'params'  => $payload,
            'id'      => $this->calls++,
        ]);
        $curl = curl_init($url);
        curl_setopt($curl, CURLOPT_POST, 1);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
        curl_setopt($curl, CURLOPT_SSLVERSION, 0);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt(
            $curl,
            CURLOPT_HTTPHEADER,
            ['Content-Type: application/json', 'Accept: application/json', 'Cookie: XDEBUG_SESSION=PHPSTORM']
        );
        curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
        $response = curl_exec($curl);
        if (empty($response)) {
            die('Server unavailable');
        }
        echo $response . '</br>';

        return json_decode($response, true);;
    }
}

$client = new Client();
$result = $client->call();
var_dump($result);

Response

Parameter	Type/Description
Reseller	Array of reseller objects.

Errors

Error	Description
MISSING_PARAMETER	Add the PartnerCode paramater in the request before calling this method.

Update reseller information

Overview

Use this method to update the details for an existing reseller entity in the Avangate platform.

Parameters

Parameter	Type/Description
sessionID	Required (string)
	Session identifier, which is the output of the Login method. An exception will be thrown if the values are incorrect.
Reseller	Required (object)

Response

Parameter	Type/Description
Result	Boolean

Request

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'MERCHANT';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/rpc/6.0';
    public const ACTION = 'updateReseller';
    //array or JSON
    public const PAYLOAD = <<<JSON
{
    "PartnerCode": "Test Avangate",
    "ResellerCode": "Q6WSZXXAA7",
    "FirstName": "test",
    "LastName": "test",
    "Company": "Test Partner 44",
    "Email": "test1111@example.com",
    "Address": "a4126f5939",
    "City": "bbbb",
    "PostalCode": "4acbc843c0",
    "Country": "RO",
    "State": "cccc",
    "Phone": "dddd",
    "Fax": "eeee"
}
JSON;

}

class Client
{
    private const LOGIN_METHOD = 'login';
    private $calls = 1;
    private $sessionId;

    private function generateAuth(): array
    {
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $date = gmdate('Y-m-d H:i:s');
        $string = strlen($merchantCode) . $merchantCode . strlen($date) . $date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);

        return compact('merchantCode', 'date', 'hash', 'algo');
    }

    public function login(string $url)
    {
        $payload = $this->generateAuth();
        $response = $this->call($url, array_values($payload), self::LOGIN_METHOD);
        $this->sessionId = $response['result'];
    }

    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?array {
        if (empty($this->sessionId) && $action !== self::LOGIN_METHOD) {
            $this->login($url);
        }
        if (is_string($payload)) {
            $payload = json_decode($payload, true);
        }
        if (!empty($this->sessionId)) {
            $payload = [$this->sessionId, $payload];
        }
        $payload = array_filter($payload);
        $request = json_encode([
            'jsonrpc' => '2.0',
            'method'  => $action,
            'params'  => $payload,
            'id'      => $this->calls++,
        ]);
        $curl = curl_init($url);
        curl_setopt($curl, CURLOPT_POST, 1);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
        curl_setopt($curl, CURLOPT_SSLVERSION, 0);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt(
            $curl,
            CURLOPT_HTTPHEADER,
            ['Content-Type: application/json', 'Accept: application/json', 'Cookie: XDEBUG_SESSION=PHPSTORM']
        );
        curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
        $response = curl_exec($curl);
        if (empty($response)) {
            die('Server unavailable');
        }
        echo $response . '</br>';

        return json_decode($response, true);;
    }
}

$client = new Client();
$result = $client->call();
var_dump($result);

Reseller

Overview

Structure

Reseller	Object
PartnerCode	String (required)
	Unique identifier that you need to specify when creating a partner in the Control Panel. You can find it under the General Information area when editing partner details.
ResellerCode	String (required)
	Unique, system generated reseller identifier.
Company	String (required)
	Reseller company name.
FirstName	String (required)
	Reseller first name.
LastName	String (required)
	Reseller last name.
Email	String (required)
	Reseller email.
Phone	String
	Reseller phone. Can be NULL.
Fax	String
	Reseller fax. Can be NULL.
Country	String (required)
	Reseller country ISO language code (ISO 639-1 two-letter code).
State	String
	Reseller state. For example, "Alabama","Alaska","Arizona". Can be NULL.
City	String
	Reseller city. Can be NULL.
Address	String
	Reseller address. Can be NULL.
PostalCode	String
	Reseller ZIP code. Can be NULL.

2Checkout API Reference 6.0

Overview

Benefits

Report components

Filters

Metric cards

Renewal & expiration events chart

Subscription renewal statuses

How to interpret the report

Overview

Parameters

Request

Errors

Overview

Parameters

Request

Response

Errors

Overview

Parameters

Response

Request

Structure

Overview

Parameters

Request

Errors

Overview

Parameters

Request

Response

Errors

Overview

Parameters

Response

Request

Overview

Structure

Need help?

Not yet a Verifone customer?