Migrating From the SOAP API

Knowledge Center > Subscriptions > Orders > Orders Tutorials > Change the Owner of a Subscription > Migrating From the SOAP API

Migrating From the SOAP API

When the Orders feature is enabled, the subscribe() and amend() calls are not available. Additionally, the create(), query(), delete(), and update() calls are disabled for amendments. You must migrate any SOAP integrations using these SOAP calls 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 Change the Owner 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>
         <obj:ContractEffectiveDate>2017-01-01</obj:ContractEffectiveDate>
         <obj:CustomerAcceptanceDate>2017-01-01</obj:CustomerAcceptanceDate>
         <obj:Name>owner transfer</obj:Name>
         <obj:ServiceActivationDate>2017-01-01</obj:ServiceActivationDate>
         <obj:Status>Completed</obj:Status>
         <obj:SubscriptionId>402892c42ce80787012ce80ea1aa0014</obj:SubscriptionId>
         <obj:DestinationAccountId>8a8081085e5a184f015e5b3172a90588</obj:DestinationAccountId>
         <obj:DestinationInvoiceOwnerId>8a8081085e5a184f015e5b3172a90588</obj:DestinationInvoiceOwnerId>
         <obj:Type>OwnerTransfer</obj:Type>
      </api:Amendments>
      <api:AmendOptions>
         <api:GenerateInvoice>false</api:GenerateInvoice>
         <api:ProcessPayments>false</api:ProcessPayments>
      </api:AmendOptions>
      <api:PreviewOptions>
         <api:EnablePreviewMode>false</api:EnablePreviewMode>
      </api:PreviewOptions>
   </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).
Last modified

Tags

This page has no custom tags.

Classifications

(not set)