Update and assign a subscription

Use the updateSubscription method to move a subscription from under a customer to another customer entity. 2Checkout moves subscription under the customer for which you provide the 2Checkout customer reference or the External customer reference during the subscription update process.

Requirements

• Use 2Checkout customer references or External customer references belonging to the target customer. 2Checkout re-assigns the subscription to the target customer.

• Customer references must be valid and associated to the target customer entity under which you move the subscription.

If you provide both the 2Checkout customer reference and External customer reference they need to belong to the same target customer entity.

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.
Subscription	Required (Object) To only move a subscription from a source customer to a target customer, send only the 2Checkout customer reference or the External customer reference.

Request sample

<?php

require ('PATH_TO_AUTH');

$SubscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE';

$jsonRpcRequest = array (
  'method' => 'getSubscription',
  'params' => array($sessionID, $SubscriptionReference),
  'id' => $i++,
  'jsonrpc' => '2.0'
);

$updatedSubscription = callRPC((Object)$jsonRpcRequest, $host, true);
var_dump ($updatedSubscription);

$updatedSubscription->AvangateCustomerReference = 'YOUR_SUBSCRIPTION_REFERENCE'; // AvangateCustomerReference is displayed as 2CheckoutCustomerReference in your Control Panel

$jsonRpcRequest = array (
  'method' => 'updateSubscription',
  'params' => array($sessionID, $updatedSubscription),
  '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.