Subscribe Preview

From API Documentation

Jump to: navigation, search

Starting with version 25.0 of the API, select customers will now have the ability preview invoices that would be generated by the subscribe() call.

To preview an invoice for subscribe()

  1. Call subscribe() as you would, passing in appropriate product rate plan and charge data
  2. Populate PreviewOptions, setting EnablePreviewMode to true, and NumberOfPeriods to the number of billing periods to include in the preview invoice.
  3. Zuora will return an InvoiceData node in the SubscribeResult, which will contain the invoice and resulting invoice items. See below for details.


Request 

<!-- sample subscribe call for preview mode -->
<ns2:subscribe>
 <ns2:subscribes>
  <ns2:Account>
   <ns1:AccountNumber>t-1246636315.4928</ns1:AccountNumber>
   <ns1:AutoPay>false</ns1:AutoPay>
   <ns1:Batch>Batch1</ns1:Batch>
   <ns1:BillCycleDay>1</ns1:BillCycleDay>
   <ns1:Currency>USD</ns1:Currency>
   <ns1:CustomerServiceRepName>CSR Dude</ns1:CustomerServiceRepName>
   <ns1:Name>Company XYZ, Inc.</ns1:Name>
   <ns1:PaymentTerm>Due Upon Receipt</ns1:PaymentTerm>
  </ns2:Account>
  <ns2:PaymentMethod>
   <ns1:CreditCardAddress1>123 Main</ns1:CreditCardAddress1>
   <ns1:CreditCardCity>San Francisco</ns1:CreditCardCity>
   <ns1:CreditCardCountry>United States</ns1:CreditCardCountry
   <ns1:CreditCardExpirationMonth>1</ns1:CreditCardExpirationMonth>
   <ns1:CreditCardExpirationYear>2011</ns1:CreditCardExpirationYear>
   <ns1:CreditCardHolderName>Test Name</ns1:CreditCardHolderName>
   <ns1:CreditCardNumber>5105105105105100</ns1:CreditCardNumber>
   <ns1:CreditCardPostalCode>94109</ns1:CreditCardPostalCode>
   <ns1:CreditCardState>California</ns1:CreditCardState>
   <ns1:CreditCardType>MasterCard</ns1:CreditCardType>
   <ns1:Type>CreditCard</ns1:Type>
  </ns2:PaymentMethod>
  <ns2:BillToContact>
   <ns1:Address1>123 Main</ns1:Address1>
   <ns1:Address2>APT 1</ns1:Address2>
   <ns1:City>San Francisco</ns1:City>
   <ns1:Country>United States</ns1:Country>
   <ns1:FirstName>Jon</ns1:FirstName>
   <ns1:LastName>Nordstrom</ns1:LastName>
   <ns1:PostalCode>94109</ns1:PostalCode>
   <ns1:State>California</ns1:State>
   <ns1:WorkEmail>test@email.com</ns1:WorkEmail>
   <ns1:WorkPhone>4155551212</ns1:WorkPhone>
  </ns2:BillToContact>
 
<!-- Preview Options - Set EnablePreviewMode to true to generate a preview invoice -->
  <ns1:PreviewOptions>
   <ns1:EnablePreviewMode>True</ns1:EnablePreviewMode>
   <ns1:NumberOfPeriods>1</ns1:NumberOfPeriods>
  </ns1:PreviewOptions> 
<!-- End PreviewOptions -->
 
  <ns2:SubscriptionData>
   <ns2:Subscription>
    <ns1:AutoRenew>true</ns1:AutoRenew>
    <ns1:ContractAcceptanceDate>2009-07-03T08:07:55-07:00</ns1:ContractAcceptanceDate>
    <ns1:ContractEffectiveDate>2009-07-03T08:07:55-07:00</ns1:ContractEffectiveDate>
    <ns1:InitialTerm>12</ns1:InitialTerm>
    <ns1:Name>A-S00000020090703080755</ns1:Name>
    <ns1:RenewalTerm>12</ns1:RenewalTerm>
    <ns1:ServiceActivationDate>2009-07-03T08:07:55-07:00</ns1:ServiceActivationDate>
    <ns1:TermStartDate>2009-07-03T08:07:55-07:00</ns1:TermStartDate>
   </ns2:Subscription>
   <ns2:RatePlanData>
    <ns2:RatePlan>
     <ns1:ProductRatePlanId>4028e6991f863ecb011fb8b7904141a6</ns1:ProductRatePlanId>
    </ns2:RatePlan>
   </ns2:RatePlanData>
  </ns2:SubscriptionData>
 </ns2:subscribes>
</ns2:subscribe>

Response 

<soapenv:Body>
        <ns1:subscribeResponse xmlns:ns1="http://api.zuora.com/">
            <ns1:result>
<!-- Preview mode: no account generated-->
 
                <ns1:AccountId xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
                <ns1:AccountNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
 
<!-- Preview mode: InvoceData wrapper is returned with invoice information -->
                <ns1:InvoiceData>
                    <ns1:Invoice xmlns:ns2="http://object.api.zuora.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:Invoice">
                        <ns2:AccountId>4028e6992b31191e012b75ae45ee1602</ns2:AccountId>
                        <ns2:Amount>500.00</ns2:Amount>
                        <ns2:AmountWithoutTax>500.00</ns2:AmountWithoutTax>
                        <ns2:TaxAmount>0.00</ns2:TaxAmount>
                    </ns1:Invoice>
                    <ns1:InvoiceItem xmlns:ns2="http://object.api.zuora.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:InvoiceItem">
                        <ns2:AccountingCode/>
                        <ns2:ChargeAmount>500.00</ns2:ChargeAmount>
                        <ns2:ChargeDate>2010-10-06T17:28:50.883-08:00</ns2:ChargeDate>
                        <ns2:ChargeDescription/>
                        <ns2:ChargeName>Setup Fee</ns2:ChargeName>
                        <ns2:ProductId>4028e6992548fa470125560f8ed1057e</ns2:ProductId>
                        <ns2:Quantity>1</ns2:Quantity>
                        <ns2:ServiceEndDate>2010-10-01T00:00:00.000-08:00</ns2:ServiceEndDate>
                        <ns2:ServiceStartDate>2010-10-01T00:00:00.000-08:00</ns2:ServiceStartDate>
                        <ns2:TaxAmount>0E-9</ns2:TaxAmount>
                        <ns2:TaxExemptAmount>0E-9</ns2:TaxExemptAmount>
                        <ns2:UnitPrice>500.000000000</ns2:UnitPrice>
                        <ns2:UOM/>
                    </ns1:InvoiceItem>
                </ns1:InvoiceData>
<!-- End InvoiceDate-->
 
 
<!-- Preview Mode: No subscription or actual invoice is generated -->
                <ns1:InvoiceId xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
                <ns1:InvoiceNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
                <ns1:SubscriptionId xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
                <ns1:SubscriptionNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="1"/>
                <ns1:Success>true</ns1:Success>
            </ns1:result>
        </ns1:subscribeResponse>
    </soapenv:Body>
Retrieved from "http://apidocs.developer.zuora.com/index.php/Subscribe_Preview"