Migrating From the SOAP API

Knowledge Center > Subscriptions > Orders > Orders Tutorials > Create 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 Create a Subscription.

SOAP Example

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

<api:subscribe>
   <api:subscribes>
      <api:Account>
         <obj:Id>2c92c0f850e512af0150ea116c180770</obj:Id>
      </api:Account>
   <api:SubscriptionData>
      <api:Subscription>
        <obj:AccountId>2c92c0f850e512af0150ea116c180770</api:AccountId>
        <obj:ContractEffectiveDate>2017-01-01</obj:ContractEffectiveDate>
        <obj:CustomerAcceptanceDate>2017-01-01</obj:CustomerAcceptanceDate>
        <obj:ServiceActivationDate>2017-01-01</obj:ServiceActivationDate>
        <obj:TermStartDate>2017-01-01</obj:TermStartDate>
        <obj:InitialTerm>12</obj:InitialTerm>
        <obj:InitialTermPeriodType>Month</obj:InitialTermPeriodType>
        <obj:TermType>TERMED</obj:TermType>                  
        <obj:RenewalTerm>12</obj:RenewalTerm>
        <obj:RenewalTermPeriodType>Month</obj:RenewalTermPeriodType>
      </api:Subscription>
      <api:RatePlanData>
        <api:RatePlan>
           <obj:ProductRatePlanId>2c92c0f85e5019d7015e513826e650f7</obj:ProductRatePlanId>
        </api:RatePlan>
      </api:RatePlanData>
     </api:SubscriptionData>
   </api:subscribes>
</api:subscribe>

Migration Notes

  • Specify the order action type as CreateSubscription.
  • Specify account numbers instead of account IDs.
  • Specify subscription numbers instead of subscription IDs.
  • 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)