Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > Amendment > Resume a Subscription (Amendment)

Resume a Subscription (Amendment)

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

Use the Resume amendment to resume a suspended subscription. 

Resuming a Subscription (WSDL 76.0 and higher) 

In version 76.0 and greater, you can use the amend() call to create a resume amendment. This call also allows you to preview the invoices before amending the subscription.

Set the following fields to suspend an active subscription:

  • Specify the following fields in the Amendment object:
    • Set Type to ResumeSubscription.
    • Specify a name for the amendment.
    • Specify the Subscription ID.
    • Set the ResumeDate. This is the date when subscription resumption takes effect. See Resume Date for more information.
    • Set ContractEffectiveDate. This is the date when the customer notifies you that they want to resume their subscription.
  • PreviewOptions: Set EnablePreviewMode to true if you want to preview what the invoice would be, including the amount and charges after the amendment, without creating the amendment. This is useful when calculating prorations and complex charges.

SOAP Example

<api:amend>
  <api:requests>
     <api:Amendments>
         <obj:ContractEffectiveDate>2019-03-01</obj:ContractEffectiveDate>         
         <obj:Description>Resume a subscription</obj:Description>         
         <obj:ResumeDate>2019-05-01</obj:SuspendDate>         
         <obj:Name>Resume a subscription</obj:Name>             
         <obj:Status>Completed</obj:Status>         
         <obj:SubscriptionId>402892c42ce80787012ce80ea1aa0014</obj:SubscriptionId>  
         <obj:Type>ResumeSubscription</obj:Type>      
      </api:Amendments>
      <api:PreviewOptions>
         <api:EnablePreviewMode>true</api:EnablePreviewMode>
      </api:PreviewOptions>
  </api:requests>
</api:amend>
Last modified

Tags

This page has no custom tags.

Classifications

(not set)