Knowledge Center

Knowledge Center > Subscriptions > Orders > Orders Tutorials > Change the Terms and Conditions of a Subscription

Change the Terms and Conditions of a Subscription

This feature is only available if you have the Orders feature enabled. We are actively soliciting feedback from a small set of early adopters. If you wish to have access to the feature, submit a request at Zuora Global Support.

This tutorial demonstrates how to change the terms and conditions of a subscription by creating an order. You will change the duration of the current term to be 20 months. You will also change the duration of the renewal term to be 6 months.

In this tutorial, you will set the following dates to today's date:

  • The date when the order is signed
  • The contract effective date of the change
  • The service activation date of the change
  • The customer acceptance date of the change

Use the REST API

You can use the "Create and activate order" operation to change the terms and conditions of a subscription.

Prior to the Orders feature being enabled, you would have used the "Update subscription", "Amend", or "CRUD: Create amendment" operation.

To change the terms and conditions of a subscription by creating an order:

  1. Determine the values of the following variables:

    Variable Description
    $SubscriptionNum The number of the subscription to update. For example, A-S00000001.
    $AccountNum The number of the account that will own the order. For example, A00000001.
    $Today Today's date. For example, 2017-09-30.
    $TermStartDate The new start date of the current term. For example, 2017-11-01.
  2. Use the "Create and activate order" operation to create an order under an existing account:

    Request POST /v1/orders/
    Request Body
    {
      "orderDate": "$Today",
      "existingAccountNumber": "$AccountNum",
      "subscriptions": [
        {
          "subscriptionNumber": "$SubscriptionNum",
          "orderActions": [
            {
              "type": "TermsAndConditions",
              "triggerDates": [
                {
                  "name": "ContractEffective",
                  "triggerDate": "$Today"
                },
                {
                  "name": "ServiceActivation",
                  "triggerDate": "$Today"
                },
                {
                  "name": "CustomerAcceptance",
                  "triggerDate": "$Today"
                }
              ],
              "termsAndConditions": {
                "lastTerm": {
                  "startDate": "$TermStartDate",
                  "period": 20,
                  "periodType": "Month",
                  "termType": "TERMED"
                },
                "renewalTerms": [
                  {
                    "period": 6,
                    "periodType": "Month"
                  }
                ],
                "renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
                "autoRenew": true
              }
            }
          ]
        }
      ],
      "processingOptions": {
        "runBilling": false,
        "collectPayment": false
      }
    }
    

    To create the order under a new account instead of an existing account, specify the newAccount field instead of the existingAccountNumber field.

To preview invoices for the updated subscription, use the "Preview order" operation.

SOAP Migration Guidance

When 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. See Migrating From the SOAP API for the SOAP equivalent of this tutorial.

Last modified

Tags

This page has no custom tags.

Classifications

(not set)