zsubscribe Method

Overview

Syntax

List<SubscribeResult> zsubscribe(List<SubscribeRequest> sub_reqs)

Input Parameters

The zsubscribe() method takes the following input parameter.

Response

The zsubscribe() method returns a list of zApi.SubscribeResult objects that ​provides the results for the  subscribe() call.

Exceptions

The zsubscribe() method uses the following exception classes to catch the exception when an error occurs during the  subscribe() call:

• zAPIException
• zForceException
• zRemoteException

Previewing an Invoice

Using the PreviewOptions object, you can preview a subscription to see the invoice charges that will be generated by the subscription.

To preview an invoice:

Sample Code

// zApiInstance should be instantiated and the login() method must
// have been invoked prior to invoking any other method on the
// object

try {
//account
Zuora.zObject acc = new Zuora.zObject('Account');
acc.setValue('Name', 'for subscribe - Account Name');
acc.setValue('Currency','USD');
acc.setValue('BillCycleDay',1);
acc.setValue('PaymentTerm','Net 30');
acc.setValue('Batch','Batch1');

//bill to contact
Zuora.zObject billToContact = new Zuora.zObject('Contact');
billToContact.setValue('FirstName','Jim');
billToContact.setValue('LastName','Green');
billToContact.setValue('WorkEmail', 'billto@zuora.com');
billToContact.setValue('Country','US');
billToContact.setValue('State','CA');

//sold to contact
Zuora.zObject soldToContact = new Zuora.zObject('Contact');
soldToContact.setValue('FirstName', 'Kate');
soldToContact.setValue('LastName', 'Green');
soldToContact.setValue('WorkEmail', 'soldto@zuora.com');
soldToContact.setValue('Country', 'US');
soldToContact.setValue('State','CA');

//payment method
Zuora.zObject pm = new Zuora.zObject('PaymentMethod');
pm.setValue('Type','Credit Card');
pm.setValue('CreditCardType', 'Visa');
pm.setValue('CreditCardNumber', '4111111111111111');
pm.setValue('CreditCardExpirationYear', '2011');
pm.setValue('CreditCardExpirationMonth', '03');
pm.setValue('CreditCardHolderName', 'Firstly Lastly');

//RatePlanCharge
Zuora.zObject rpc = new Zuora.zObject('RatePlanCharge');
rpc.setValue('ProductRatePlanChargeId', '4028e6962f001d02012f0aa37bc60dbb');
rpc.setValue('Quantity', 50.00);

Zuora.zObject rpcd = new Zuora.zObject('RatePlanChargeData');
rpcd.setValue('RatePlanCharge', rpc);

Zuora.zObject rp = new Zuora.zObject('RatePlan');
rp.setValue('ProductRatePlanId', '4028e6962f001d02012f0aa290a50c7b');

Zuora.zObject rpd = new Zuora.zObject('RatePlanData');
rpd.setValue('RatePlan', rp);
rpd.setValue('RatePlanChargeData', new List<Zuora.zObject>{rpcd});

//subscription
Zuora.zObject sub = new Zuora.zObject('Subscription');
sub.setValue('Name', 'subscription - SubscriptionName');
sub.setValue('ContractEffectiveDate', '2011-04-01T02:47:06');
sub.setValue('InitialTerm', 12);
sub.setValue('RenewalTerm', 12);

//subscription data
Zuora.zApi.SubscriptionData sd = new Zuora.zApi.SubscriptionData();
sd.Subscription = sub;
sd.RatePlanData = new List<Zuora.zObject> {rpd};

//subscription options
Zuora.zApi.SubscribeOptions so= new Zuora.zApi.SubscribeOptions();
so.GenerateInvoice = true;
so.ProcessPayments = false;

//Preview options
Zuora.zApi.PreviewOptions previewOpt = new Zuora.zApi.PreviewOptions();
previewOpt.EnablePreviewMode = true;
previewOpt.NumberOfPeriods = numOfPeriods;

//subscribe request
Zuora.zApi.SubscribeRequest subsRequest = new
Zuora.zApi.SubscribeRequest();

subsRequest.ZAccount = acc;
subsRequest.BillToContact = billToContact;
subsRequest.SoldToContact = soldToContact;
subsRequest.SubscribeOptions = so;
subsRequest.SubscriptionData = sd;
subsRequest.PaymentMethod = pm;

subsRequest.PreviewOptions = previewOpt;

List<Zuora.zApi.SubscribeRequest> subsRequestLists = new
List<Zuora.zApi.SubscribeRequest>{subsRequest};

List<Zuora.zApi.SubscribeResult> subscribeResults =
zApiInstance.zsubscribe(subsRequestLists);

for (Zuora.zApi.SubscribeResult result : subscribeResults) {
if (result.Success) {
//Handle with the invoice data returned by previewing subscriptions
  if (result.InvoiceDatas != null) {
    for (Zuora.zObject invData: result.InvoiceDatas) {
      //in Preview mode, handle with the invoice data
      Zuora.zObject invoice = (Zuora.zObject) invData.getValue( 'Invoice' );
      Decimal amount = ( Decimal ) invData.getValue( 'Amount' );
      List<Object> invoiceItems = invData.getArrayValue( 'InvoiceItem' );
      if( invoiceItems != null ){
        for( Object invoiceItem : invoiceItems ){
          Zuora.zObject zInvoiceItem = ( Zuora.zObject ) invoiceItem;
          //zInvoiceItem.getValue( 'ChargeAmount' )
          //zInvoiceItem.getValue( 'ChargeDate' );
        }
      }
    }
  }
} else {
//failure
//get the errors
Zuora.zObject[] errors = result.errors;
for (Zuora.zObject error : errors) {
String errorCode = (String)error.getValue('Code');
String message = (String)error.getValue('Message');
//more code here...
}
}
}
} catch (Zuora.zRemoteException ex) {
if ('INVALID_FIELD' == ex.code) {
// An invalid field was specified
//more code here...
} else {
//more code here...
}
} catch (Zuora.zAPIException ex) {
ex.getMessage();
//more code here...
} catch (Zuora.zForceException ex) {
//more code here...
}