Overview

Use the getAdditionalOrderField method to extract information about a specific additional field you set up for your account.

Parameters

Request

<?php
 
require ('PATH_TO_AUTH');

$fieldCode = 'YOUR_FIELD_CODE';
 
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getAdditionalOrderField',
'params' => array($sessionID, $fieldCode)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
 ?>

Response

Overview

Use the searchOrders method via JSON-RPC API 6.0 to retrieve multiple orders depending on the filter parameters. 

Request Parameters

Request Example

<?php

require ('PATH_TO_AUTH');

$orderSearchOptions = new stdClass();
$orderSearchOptions->StartDate = “2020-01-23”;
$orderSearchOptions->PartnerOrders = true;
$orderSearchOptions->Pagination = new stdClass();$orderSearchOptions->Pagination->Page = 2;
$orderSearchOptions->Pagination->Limit = 25;

try {
    $orders = $client->searchOrders($sessionID, $orderSearchOptions);
}
catch (SoapFault $e) {
    echo "orders: " . $e->getMessage();
    exit;
}

var_dump("orders", $orders);
               
?>

Response

A successful searchOrders call via JSON-RPC API 6.0 returns:

Overview

Use the Product object to create/add, update/edit and retrieve subscription plans/products for your account. You can control:

• Product information
• Pricing
• Subscription plan settings and renewal configuration
• Subscription plan recurring billing
• Fulfillment
• Shipping classes
• Localization

Overview

Dynamic pricing (with base price) is a basic charge configuration. 2Checkout supports both one-time and recurring dynamic pricing, and offers the possibility to control various cost components through product options pricing. 

Examples:

• A $99.99 recurring, annual anti-malware subscription.
• A recurring, monthly $20 subscription to a service providing credit score information.
• A flat, one-time fee of $1,000 for the license to a CRM software. 

If the pricing configuration has a base price but the customer should be able to alter it by choosing from product options (like subscription types, number of users, platforms), then enter a base price and choose between Net and Gross price type. Extra pricing options can be dynamically added after the product is added, based on formulas from the 2Checkout system.

Availability

All 2Checkout accounts. 

Requirements

Create at least a product/subscription plan before defining pricing. 

Type

• Net: without taxes - 2Checkout applies extra taxes to the default price, such as Tax/VAT for US/EU orders during  the ordering process. 
• Gross: with taxes included - 2Checkout takes the taxes out of the costs paid by shoppers, without modifying the price during the ordering process. 

Currency

When defining product prices you can:

1. Configure the price only for the default currency - 2Checkout converts amounts in the cart based on the currency selected by/for shoppers. Currency rates are available here: https://secure.2checkout.com/content/...p?CURRENCY=USD. 

   This is an XML schema with the corresponding values for the other currencies compared to the one supplied in the CURRENCY query parameter.

2. Specify prices in all currencies available for your account - 2Checkout serves shoppers the prices for all the currencies you set up without converting the amounts. 

Basic setup

You can set up basic pricing when first defining your product and then edit the charge configuration as well as utilize advanced charge capabilities. 

1. Choose the default currency, select the base price option and enter the product price.
2. After filling in the base price for your product, you can:
   
   • Let the 2Checkout platform auto convert it to other currencies during the ordering process;
   • Manually set the price for each currency.
3. If you choose to manually enter the price for some currencies only, then 2Checkout automatically converts the ones you left blank from the default currency during the ordering processing.
4. Extra taxes may be applied to the base price during the ordering process, such as VAT for EU orders, or sales tax for the US. You can choose not to have country specific taxes added to the price in the shopping cart by selecting with taxes included (Gross). This means that the country specific tax fees will be pulled from the product price during ordering process. With the Net option, the 2Checkout system will charge shoppers VAT and sales taxes, when these apply, in addition to the price of the product, and deal with tax management on your behalf. 

Advanced setup

Access advanced pricing/charge options by editing product and navigating to the Pricing tab. This area enables you to edit and create pricing configurations and create charge models that include:

• Volume pricing
• Custom recurring charges
• Advanced pricing options
• Pay-per-use (Metered billing)
• Tiered charges

Overview

If you are using our Avangate Affiliate Network it's important to understand the details related to the quality and potential of the traffic generated by your affiliates.

To monitor and analyze the affiliate-referred traffic, you might be using any analytics tools such as Google Analytics, and/or Adobe Analytics, but not only. Now you can do this by using any type of parameters you want, including, but not only, UTM parameters. These are automatically parsed by both Google Analytics and Adobe Analytics, so you are able to populate standard and custom analytics reports. 

Availability

Available upon request to merchants using the Avangate Affiliate Network.

Benefits

• Full flexibility in defining the name and the value of the parameters (both static and dynamic)
• Easy integration with Google/ Adobe Analytics or any other analytics tool merchants use
• No need for affiliates to perform additional actions when generating new links
• No need for affiliates to change previously generated links

Workflow

If you are using an affiliate network (including Avangate Affiliate Network) and you want to understand the type of users each network brings, as well as analyze the traffic crossing between affiliates (using Google Analytics or any other analytics tool) you can easily set up any type of parameters, including UTM (Universal Tag Manager) parameters.

1. Log into your Merchant Control Panel.
2. Navigate to Affiliate network → Settings.
3. Click on the Tracking settings tab to define custom parameters.
4. Click on Add parameter to add the static or dynamic parameters that will be used to identify traffic generated by all networks (e.g. utm_source and utm_medium).

5. Input the parameter Name and Value (e.g. utm_source = AVAffiliate, utm_medium = AffiliateID), and click on Save changes.

6. To modify a parameter, go to the list of Available parameters and click on the Edit button in the column Actions. 

7. Then click on Save changes.

Affiliate links triggering merchant website/landing page will be available through the above set parameters via any analytics tool.

Affiliate links triggering cart/product pages will populate these parameters in the omniture parameter collection (that can be easily integrated with either Google Analytics or any other analytics tool).

The omniture_vars Object

The 2Checkout shopping cart pages use an object called omniture_vars, which contains a variety of parameters that offer information about the particularities of the cart and the products in it. The object can be accessed by typing “omniture_vars” in the browser console.

The object contains detailed information about the products in the cart (examples: product name, id, price, product group, pricing options, whether the product is an upsell or a cross-sell, etc.), as well as information about the configuration of the shopping cart, such as cart currency, language, the selected country, the id of the template used, whether the cart flow has a review page, whether the cart is in test mode, or whether the cart link is generated by a 2Checkout affiliate.

The values of the parameters in the omniture_vars object are updated when the page refreshes. For example, if the currency is changed in the cart, the page refreshes and the omniture_vars object is updated with the new value for the currency.

Parameters from omniture_vars can be used for custom tracking, for example for sending custom dimensions data to Google Analytics with specific information about the cart configuration.

Overview

A common pitfall throughout the eCommerce landscape is represented by focusing on customer base growth at the expense of neglecting existing customers. While growing your customer base is key to a business's success, customer retention is equally important, especially from a financial standpoint. One of the most frequent mistakes businesses do in terms of customer retention is ignoring the customers once they brought them on board.

Analyzing customer data from hundreds of companies in our portfolio, we’ve concluded that shoppers are much more invested in continuing their subscriptions when approached through proactive retention strategies. As a result, online renewals proved to be more than twice as effective as offline ones, while automatic renewals saved three times more subscriptions than manual ones.

While developing your retention subscriber retention strategy, make sure to clearly inform your users about the incurred charges and billing cycles, and give them the ability to easily cancel automatic renewals, should they not need them. Keep in mind that placing your customers in control of their subscription management process is paramount to preventing and reducing your refunds and/or chargeback rates.

2Checkout’s retention tools introduce a smart and easy way to reduce customer churn and gain useful insights about what drives customers to cancel automatic renewals. Use 2Checkout’s out of the box retention capabilities to:

• Leverage proactive subscription enrollment to increase renewals and generate additional revenue. Use special deals to deepen loyalty and incentivize your customers to enroll in automatic subscription renewals.
• Decrease churn and prevent recurring revenue from “leaking” by converting cancelations into continued subscriptions. Offer the right incentives to the customers that decided to cancel their subscriptions and make them change their mind at the point of exit.
• Turn threats into opportunities by capturing your customers’ feedback at the point of cancelation.

Auto-renewal enrollment

If your customers purchased subscriptions from you and disabled the automatic renewal upon purchase, try to convert them to a recurring billing plan. An easy way to increase your revenue and customer retention rate is by proactively incentivizing your customers to enroll in auto-renewal campaigns. Do this via 2Checkout’s retention tools and configure discounts for one or multiple billing cycles. Your customers see the discounts in 2Checkout myAccount and they can quickly enable automatic renewal from their account.

Important: 2Checkout triggers auto-renewal enrollment campaigns only for products/subscriptions paid for with online payment methods.

2Checkout recommendations

Based on existing auto-renewal enrollment campaigns, 2Checkout recommends starting with a 15% discount for one billing cycle.

2Checkout vendors have successfully configured proactive enrollment campaigns offering discounts from 15% up to 25% for one billing cycle. This ultimately led to increases in sales of up to three times the value of the awarded discounts without counting the entire customer lifecycle value.

We recommend testing such campaigns for specific products with different time intervals and with different tiers of discounts. This way you can choose the best discounts for your customers and increase revenue and their lifetime value.

Behavior

Use promotions to enroll your customers in auto-renewal campaigns by leveraging 2Checkout myAccount. Your customers will see campaign teasers such as the one below.

Churn prevention

Subscribers enrolled in auto-renewal campaigns are 3.5 times more likely to continue their subscriptions. Churn prevention tools help you prevent recurring revenue from “leaking” by converting terminations into continued subscriptions.

2Checkout gives you an easy way to configure churn prevention campaigns so that you can:

• Engage and collect feedback from your churning subscribers to optimize your products, marketing campaigns, and business operations. You can extract valuable information from cancellation reasons, such as pricing, feature ideas, competitor information, or just service quality improvements.
• Solidify your recurring revenue by offering discounts to customers who want to cancel recurring billing, incentivizing them to keep auto-renewal enabled for their subscriptions.

2Checkout recommendations

Based on existing churn prevention campaigns, 2Checkout recommends asking for customer feedback and subsequently offers a 15% to 35% discount for one billing cycle. This configuration ultimately led to an increase in recovered volumes of more than 4 times the value of the awarded discounts, not considering the entire customer lifecycle value.

Behavior

Once you've started the campaign, your shoppers are notified in myAccount whenever they try to stop subscription auto-renewals for the products included in the campaign. You can customize the message displayed to your shoppers and choose whether or not to gather feedback.

The first pop-up displays either the default message shown below or the one you customize.

The next pop-up asks for a cancellation reason and shopper feedback (if you choose to gather it).

The last pop-up shows the discount that you offered for keeping the auto-renewal.

Should customers accept your discount, 2Checkout renews the subscription at the specified discounted price and improves your churn rate.

Conclusion

2Checkout’s retention tools are a key feature in increasing your revenue and customer lifetime value through customer incentives. At the same time, they can help you get important insights on how your customers see your products, what they love and/or dislike about them and what you can do to stay competitive.

Make sure you configure retention campaigns and test multiple scenarios. Different customers have different needs, so they might react differently to unique discounts. Incentivize them to keep their subscriptions active and fine-tune your retention campaigns for maximum impact on your revenue and churn rate.

Overview

Upload usage data through the 2Checkout API from a CSV (comma-separated values) file. 2Checkout will capture the parameters sent and import the usage data into the system. Once the upload process is complete, you'll be able to access the uploaded file in the Usage area of the Merchant Control Panel.

Use the importUsageFromCsv method via SOAP APIv6 to upload usage from a CSV file.

Set the DATE parameter to GMT+2 time zone, when making the API call to the Usage Upload endpoint.

Method and URL

POST: https://api.2checkout.com/subscription/payperusage/receiver/index.php

Parameters

Request Example

<?php
//hmac
$date             = date("Y-m-d");
$fileReceived_md5 = md5_file("[Path to the CSV file used for usage upload]");
$merchantCode     = "";
/* 2Checkout Code */
$merchantKey      = "";
/* Merchant Secret Key */
$hashParams       = "MERCHANT={$merchantCode}&FILE={$fileReceived_md5}&DATE={$date}";
$hmac             = hash_hmac('md5', $hashParams, $merchantKey);
?>

<html>
<body>
<form method="post" action="https://api.2checkout.com/subscription/payperusage/receiver/index.php" enctype="multipart/form-data">
<input type="text" name="MERCHANT" value="<?php
echo $merchantCode;
?>" /><br />
<input type="text" name="HASH" value="<?php
echo $hmac;
?>" /><br />
<input type="file" name="OPTIONS" /><br />
<input type="hidden" name="FILE_MD5" value="<?php
echo $fileReceived_md5;
?>" />
<input type="hidden" name="DATE" value="<?php
echo $date;
?>" />
<input type="submit" /><br />
</form>
</body>
</html>

Error handling

Overview

Use the deletePromotionSources method to define new sources for an existing promotion.

Parameters

Response

Request

<?php

function callRPC($Request, $host, $Debug = true) {
    $curl = curl_init($host);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($curl, CURLOPT_VERBOSE, true);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($curl, CURLOPT_SSLVERSION, 0);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));
    $RequestString = json_encode($Request);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $RequestString);
    if ($Debug) {
        $RequestString;
    }
    $ResponseString = curl_exec($curl);
    if ($Debug) {
        $ResponseString;
    }
    if (!empty($ResponseString)) {
        var_dump($ResponseString);
        $Response = json_decode($ResponseString);
        if (isset($Response->result)) {
            return $Response->result;
        }
        if (!is_null($Response->error)) {
            var_dump($Request->method, $Response->error);
        }
    } else {
        return null;
    }
}

$host = 'https://api.avangate.com/rpc/3.1/';

$merchantCode = "YOUR_MERCHANT_CODE"; // your account's merchant code available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
$key = "YOUR_SECRET_KEY"; // your account's secret key available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php

$string = strlen($merchantCode) . $merchantCode . strlen(gmdate('Y-m-d H:i:s')) . gmdate('Y-m-d H:i:s');
$hash = hash_hmac('md5', $string, $key);

$i = 1;

$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'login';
$jsonRpcRequest->params = array($merchantCode, gmdate('Y-m-d H:i:s'), $hash);
$jsonRpcRequest->id = $i++;

$sessionID = callRPC($jsonRpcRequest, $host);

// Promotion code corresponding to the promotion you want to remove sources from
$promotionCode = '';

// Sources array with the source values 
$sources = ['source1', 'source2'];

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'deletePromotionSources',
'params' => array($sessionID, $promotionCode, $sources)
);
var_dump (callRPC($jsonRpcRequest, $host));

Overview

Use this object to retrieve information about additional order/product fields. 

Parameters

Overview

Use the addPricingConfiguration method to add a new pricing configuration for your account.

Parameters

Response

bool(true)

Request

<?php

require ('PATH_TO_AUTH');

$PricingConfiguration = new stdClass();
$PricingConfiguration->Default = True;
$PricingConfiguration->Name = 'New Pricing Configuration Through API';
$PricingConfiguration->BillingCountries = array();
$PricingConfiguration->BillingCountries[0] = 'RO';
$PricingConfiguration->BillingCountries[1] = 'DE';
$PricingConfiguration->PricingSchema = 'DYNAMIC';
$PricingConfiguration->PriceType = 'NET';
$PricingConfiguration->DefaultCurrency = 'USD';
$PricingConfiguration->Prices = new stdClass();
$PricingConfiguration->Prices->Regular = array();
$PricingConfiguration->Prices->Regular[0] = new stdClass();
$PricingConfiguration->Prices->Regular[0]->Amount = 69.09;
$PricingConfiguration->Prices->Regular[0]->Currency = 'USD';
$PricingConfiguration->Prices->Regular[0]->MinQuantity = 1;
$PricingConfiguration->Prices->Regular[0]->MaxQuantity = 35;
$PricingConfiguration->Prices->Regular[0]->OptionCodes = array();
$PricingConfiguration->Prices->Regular[0]->OptionCodes[0] = new stdClass();
$PricingConfiguration->Prices->Regular[0]->OptionCodes[0]->Code = 'G77ICHEM1C';
$PricingConfiguration->Prices->Regular[0]->OptionCodes[0]->Options = array();
$PricingConfiguration->Prices->Regular[0]->OptionCodes[0]->Options[0] = 'zh5onfolw7';
$PricingConfiguration->Prices->Regular[0]->OptionCodes[0]->Options[1] = '75rjldfcnz';
$PricingConfiguration->Prices->Regular[0]->OptionCodes[1] = new stdClass();
$PricingConfiguration->Prices->Regular[0]->OptionCodes[1]->Code = 'BAWAQB8LZP';
$PricingConfiguration->Prices->Regular[0]->OptionCodes[1]->Options = array();
$PricingConfiguration->Prices->Regular[0]->OptionCodes[1]->Options[0] = 'r3oi06opvi';
$PricingConfiguration->Prices->Regular[0]->OptionCodes[1]->Options[1] = '76gqbq4bhd';
$PricingConfiguration->Prices->Regular[1] = new stdClass();
$PricingConfiguration->Prices->Regular[1]->Amount = 64.66;
$PricingConfiguration->Prices->Regular[1]->Currency = 'USD';
$PricingConfiguration->Prices->Regular[1]->MinQuantity = 36;
$PricingConfiguration->Prices->Regular[1]->MaxQuantity = 83;
$PricingConfiguration->Prices->Regular[1]->OptionCodes = array();
$PricingConfiguration->Prices->Regular[1]->OptionCodes[0] = new stdClass();
$PricingConfiguration->Prices->Regular[1]->OptionCodes[0]->Code = '8RNXV3T3RE';
$PricingConfiguration->Prices->Regular[1]->OptionCodes[0]->Options = array();
$PricingConfiguration->Prices->Regular[1]->OptionCodes[0]->Options[0] = 'rorqkqnd9p';
$PricingConfiguration->Prices->Regular[1]->OptionCodes[0]->Options[1] = 'aeu89gqdg6';
$PricingConfiguration->Prices->Regular[1]->OptionCodes[1] = new stdClass();
$PricingConfiguration->Prices->Regular[1]->OptionCodes[1]->Code = 'DJYD713MKC';
$PricingConfiguration->Prices->Regular[1]->OptionCodes[1]->Options = array();
$PricingConfiguration->Prices->Regular[1]->OptionCodes[1]->Options[0] = 'y2z2squ7c1';
$PricingConfiguration->Prices->Regular[1]->OptionCodes[1]->Options[1] = 'g74qfskbjg';
$PricingConfiguration->Prices->Renewal = array();
$PricingConfiguration->Prices->Renewal[0] = new stdClass();
$PricingConfiguration->Prices->Renewal[0]->Amount = 7.89;
$PricingConfiguration->Prices->Renewal[0]->Currency = 'USD';
$PricingConfiguration->Prices->Renewal[0]->MinQuantity = 84;
$PricingConfiguration->Prices->Renewal[0]->MaxQuantity = 100;
$PricingConfiguration->Prices->Renewal[0]->OptionCodes = array();
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[0] = new stdClass();
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[0]->Code = '73QCSXYH0E';
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[0]->Options = array();
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[0]->Options[0] = '54xu7mngqm';
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[0]->Options[1] = 'p6m8im2unl';
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[1] = new stdClass();
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[1]->Code = '0QD0CF0OIE';
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[1]->Options = array();
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[1]->Options[0] = 'ytbac9wpmh';
$PricingConfiguration->Prices->Renewal[0]->OptionCodes[1]->Options[1] = 'lpkxxqsqxb';
$PricingConfiguration->Prices->Renewal[1] = new stdClass();
$PricingConfiguration->Prices->Renewal[1]->Amount = 76.99;
$PricingConfiguration->Prices->Renewal[1]->Currency = 'USD';
$PricingConfiguration->Prices->Renewal[1]->MinQuantity = 101;
$PricingConfiguration->Prices->Renewal[1]->MaxQuantity = 544;
$PricingConfiguration->Prices->Renewal[1]->OptionCodes = array();
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[0] = new stdClass();
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[0]->Code = '03APF0H4QF';
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[0]->Options = array();
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[0]->Options[0] = '15ce5uw2j6';
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[0]->Options[1] = 'e88d5hk0tb';
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[1] = new stdClass();
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[1]->Code = 'PT00TYI2VY';
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[1]->Options = array();
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[1]->Options[0] = '10c24smlbl';
$PricingConfiguration->Prices->Renewal[1]->OptionCodes[1]->Options[1] = '0ondbwdk3q';
$PricingConfiguration->PriceOptions = array();
$PricingConfiguration->PriceOptions[0] = new stdClass();
$PricingConfiguration->PriceOptions[0]->Code = 'FKQ8CFLYKM';
$PricingConfiguration->PriceOptions[0]->Required = false;
$PricingConfiguration->PriceOptions[1] = new stdClass();
$PricingConfiguration->PriceOptions[1]->Code = 'TH1HKFOTFR';
$PricingConfiguration->PriceOptions[1]->Required = true;

$ProductCode= 'API_Imported_123456';

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'addPricingConfiguration',
'params' => array($sessionID, $PricingConfiguration, $ProductCode) //Use product ID and not product code for API versions 2.3 and earlier
);

var_dump (callRPC((Object)$jsonRpcRequest, $host));

?>