Add/Import test subscriptions without credit/debit card data
Overview
Import test subscription and data from your or a third-party system and test advanced renewal and upgrade scenarios in the Avangate platform. Contact Avangate directly for additional details.
Use the addSubscription method to import a test subscription into the Avangate system.
Requirements
Test subscriptions can be imported only for eStore orders.
Parameters
Parameters | Type/Description |
---|---|
sessionID |
Required (string) |
|
Session identifier, the output of the Login method. Include sessionID into all your requests. Avangate throws an exception if the values are incorrect. The sessionID expires in 10 minutes. |
Required (Object) |
|
|
Object designed to provide Avangate with all the information to create a subscription. |
Test | Optional (integer) |
To add test subscriptions, set the Test parameter to 1. Default value is 0, and belongs to regular subscriptions. |
Response
Parameters | Type/Description |
---|---|
SubscriptionReference |
String |
|
Unique, system-generated subscription identifier. |
Request
<?php require ('PATH_TO_AUTH'); $Product = new stdClass (); $Product->ProductCode = 'my_subscription_1'; $Product->ProductId = 4639321; $Product->ProductName = 'Avangate Subscription Imported'; $Product->ProductVersion = 1.0; $Product->ProductQuantity = 3; $Product->PriceOptionCodes = array(); $EndUser = new stdClass (); $EndUser->Address1 = 'Address line 1'; $EndUser->Address2 = 'Address line 2'; $EndUser->City = 'LA'; $EndUser->Company = 'Company Name'; $EndUser->CountryCode = "US"; $EndUser->Email = 'customerAPI@avangate.com'; $EndUser->FirstName = 'Customer'; $EndUser->Language = 'en'; $EndUser->LastName = 'Avangate'; $EndUser->Phone = '1234567890'; $EndUser->State = 'California'; $EndUser->Fax = NULL; $EndUser->Zip = '90210'; $Subscription = new stdClass(); $Subscription->ExternalSubscriptionReference = '12345678912ImportedSubscription'; $Subscription->SubscriptionCode= NULL; $Subscription->StartDate = '2013-01-01'; $Subscription->ExpirationDate = '2017-12-30'; $Subscription->Product = $Product; $Subscription->EndUser = $EndUser; $Subscription->ExternalCustomerReference = '12354678ExtCustRef'; $Subscription->Test = 1; // send 1 for test subscription, 0 for regular subscriptions. $jsonRpcRequest = array ( 'method' => 'addSubscription', 'params' => array($sessionID, $Subscription), 'id' => $i++, 'jsonrpc' => '2.0'); var_dump (callRPC((Object)$jsonRpcRequest, $host, true));