Skip to main content

Migrating From the SOAP API

Zuora

Migrating From the SOAP API

When the Orders Harmonization feature is enabled, you can continue to use Subscribe and Amend SOAP APIs to create and manage your subscriptions. If you want to migrate your SOAP integrations to use the Orders REST API, you can still do it.

To assist with the migration, this article provides the SOAP equivalent of the "Create order" request body shown in Change the Terms and Conditions of a Subscription.

SOAP Example

The following SOAP amend() example is valid for WSDL version 29.0 and later.

<api:amend>        
  <api:requests>           
    <api:Amendments>                            
      <ns2:ContractEffectiveDate>2017-01-01</ns2:ContractEffectiveDate>  
      <ns2:CustomerAcceptanceDate>2017-01-01</ns2:CustomerAcceptanceDate>
      <ns2:ServiceActivationDate>2017-01-01</ns2:ServiceActivationDate>
      <ns2:SubscriptionId>2c92c0f85d7d53d3015dac494e3d5cc4</ns2:SubscriptionId> 
      <ns2:Type>TermsAndConditions</ns2:Type> 
      <ns2:TermStartDate>2017-03-01</ns2:TermStartDate>    
      <ns2:CurrentTerm>20</ns2:CurrentTerm>
      <ns2:CurrentTermPeriodType>Month</ns2:CurrentTermPeriodType>
      <ns2:RenewalTerm>6</ns2:RenewalTerm>
      <ns2:RenewalTermPeriodType>Month</ns2:RenewalTermPeriodType>
      <ns2:AutoRenew>true</ns2:AutoRenew> 
      <ns2:Status>Completed</ns2:Status> 
      <ns2:Name>changing terms and conditions</ns2:Name>
    </api:Amendments>                    
  </api:requests>     
</api:amend>

Migration Notes

  • Specify account numbers instead of account IDs.
  • Specify subscription numbers instead of subscription IDs.
  • You do not need to specify the status of the amendment in the REST API. Because the amendment will be in the Complete status if the call succeeds. You cannot create draft amendments in Orders.
  • To generate invoices and collect payments, specify the runBilling and collectPayment fields instead of the GenerateInvoice and ProcessPayments SOAP fields.
  • Currently, we do not support specifying the name and description of order actions (the corresponding Name and Description SOAP fields).