Knowledge Center

Knowledge Center > Subscriptions > Orders > Orders Tutorials > Cancel a Subscription > Migrating From the SOAP API

Migrating From the SOAP API

If the Orders feature is enabled in your Zuora tenant, the SOAP API is not available. You must migrate any SOAP integrations to use the REST API instead.

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

SOAP Example

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

<api:amend>
  <api:requests>
     <api:Amendments>
         <obj:ContractEffectiveDate>2017-01-01</obj:ContractEffectiveDate>
         <obj:CustomerAcceptanceDate>2017-01-01</obj:CustomerAcceptanceDate>
         <obj:ServiceActivationDate>2017-01-01</obj:ServiceActivationDate>              
         <obj:EffectiveDate>2017-01-01</obj:EffectiveDate>                                           
         <obj:Status>Completed</obj:Status>        
         <obj:SubscriptionId>402892c42ce80787012ce80ea1aa0014</obj:SubscriptionId> 
         <obj:Type>Cancellation</obj:Type>  
         <obj:Name>Cancel a subscription</obj:Name>       
         <obj:Description>Cancel a subscription</obj:Description>    
      </api:Amendments>
      <api:PreviewOptions>
         <api:EnablePreviewMode>false</api:EnablePreviewMode>
      </api:PreviewOptions>
  </api:requests>
</api:amend>

Migration Notes

  • Specify the subscription number instead of subscription ID.
  • Specify the type to CancelSubscription instead of Cancellation.
  • The effective date specified in the SOAP EffectiveDate field corresponds to the cancellation effective date of the order action in the REST API.
  • 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).
Last modified

Tags

This page has no custom tags.

Classifications

(not set)