Skip to main content

Create an order line item with a new subscription

Zuora

Create an order line item with a new subscription

You can create an order line item together with a new subscription using one of the following approaches:

  • Use the Zuora application (the Zuora UI)
  • Use the "Create an order" operation

If you want to create only an order line item, see Create an Order Line Item for details.

Use the Zuora application 

  1. Log in to the Zuora application and then navigate to Customers > Orders. The Orders page opens.
  2. Click Create New Order at the top right. The Create New Order page opens.
  3. In the Order Overview area, enter the name of the account that owns the order in the Account field. By default, the account that owns the order will also own the order line item.
    You can enter the account by clicking either Account Name or Account Number.
    • If you click Account Name, type part of the account name in the Account field and the filtered accounts can be dynamically listed for your selection.
    • If you click Account Number, type the complete account number.
  4. In the Order Date field, enter the order date you want to assign to the order.
  5. Create a new subscription.
    1. In the Associated subscriptions area, click CREATE SUBSCRIPTION on the right. The Create Subscription page is displayed.
    2. Provide detailed information about the new subscription. See the Fields for creating new subscriptions section for more information about each field.
    3. Click Continue.
    4. In the Products and charges area, search and locate the product to be added. You can choose to search by product name or by product SKU by using the drop-down list. The displayed products will dynamically change as you type in the Search field.
    5. To add a rate plan, click the right arrow ( > ) next to the product name to expand its rate plans, and then select the rate plan you want to add to the subscription.
      You can select more than one rate plan in multiple products. To remove a rate plan from your selection, clear the checkbox in front of the rate plan. The number of the selected rate plan is also indicated in the UI.
    6. Click Add Product.
    7. (Optional): Update the charges for the selected rate plan if necessary.
    8. Click Review Order. Then you can preview the following information from the Associated Subscriptions area:
      • Included Products
      • Order Actions
      • Terms
      • Ramp Metrics
    9. (Optional): If you want to update the subscription, you can:
      • Click Add Product to add more products and rate plans to the subscription.
      • Click Update Terms and Conditions to update the terms and conditions of the subscription.
      • Click More Order Actions and select the corresponding action from the menu to do further updates such as transferring the owner and suspending the subscription.
  6. Create Order Line Items.
    1. In the Order Line Items area, click ADD ORDER LINE ITEM on the right. The Add Order Line Item window is displayed.
    2. Provide detailed information about the order line item. See the Fields for creating order line items section for more information about each field.
    3. After you are finished, click Save. The Add Order Line Item window is closed.
    4. (Optional): Repeat Step a - c to create more order line items as you need in the current order. The maximum number of order line items allowable in an order is 100. Use the Actions link to either edit or delete an order line item after creation.
  7. (Optional): To preview billing information for the order, click Preview Billing. Specify the preview settings and click Update Preview to see the preview invoices. After you are finished, click Back to return to the previous page.
  8. Click Activate to activate the order.

Fields for creating new subscriptions

The following table lists the description of all fields for creating a new subscription:

Section Field name Description
Subscription Overview Subscription Owner This field is automatically populated based on the Account field specified in Step 3.
Type The subscription type. It can be termed or evergreen.
Terms and Conditions Term Start Date This field determines when a subscription term starts. 
Initial Term The length of the period for the first subscription term. 
Period Type The period type for the first subscription term. It can be one of the following values:
  • Month
  • Week
  • Year
  • Day
Renewal Setting

If you set the Term Setting to Termed, you must also select one of the following Renewal Setting options:

  • Renew With Specific Term: If you select this option, you must also set the Renewal Term. The subscription remains termed when it is renewed. The subscription will renew for the number of months specified in the Renewal Term field.
  • Renew To Evergreen: If you select this option, the subscription automatically changes from termed to evergreen when it is renewed. A renewal term is not required for evergreen subscriptions.
Renewal Term The length of the periods your subscription will renew for after the initial term ends.
Auto renew When the initial term for a subscription is over, the subscription will automatically renew if you select the Auto renew check box.
Invoice The Subscription Separately Indicates on a per-subscription basis whether the subscription should be invoiced separately. See Invoicing Subscriptions Separately for more information.
Ramp Ramp enabled Indicates if this subscription is a ramp deal. See Overview of Ramps and Ramp Metrics for more information.
If you select this check box, you also need to specify the ramp interval duration in the Interval Duration dropdown list.
Custom Fields SUB_CF_[Number] The custom fields on the Subscription object.
Quote Fields Quote Number The unique identifier of the Quote. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
Quote Type The Quote type represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel.  If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
Quote Business Type The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn.   If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
Opportunity Name The unique identifier of the Opportunity.  If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
Opportunity Close Date The closing date of the Opportunity.  If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
Trigger Dates Contract Effective
Service Activation
Customer Acceptance
For details about these dates of a subscription, see Billing Trigger Dates.
Custom Fields OA_CF_[Number] The custom fields on the Order Action object.

Fields for creating order line items

The following table lists the description of all fields for creating a new subscription:

Section Field name Description
Basic Information Item Name Required field. Name of the order line item. This name represents the name of the object that is sold and will typically be displayed on invoices, quotes, portals, and so on.
Product Code The product code that is used as an identifier for the downstream system. This code is used to map the products in external systems such as the SKU in an external product catalog or a provisioning system.
Item Type Required field. The category of the order line item. Valid values are Fee, Product, and Services.
Transaction Date The date of the order line item transaction. If it is not specified, the Order date will be used as the transaction date.
Description A brief description of the order line item for reference.
Item State State of the order line item. Valid values are Executing, Sent To Billing, Complete, and Canceled. By default, the starting state of an order line item is Executing. For more information, see Order Line Item States and Order States.
Bill Target Date

The date when the order line item will be invoiced.

Pricing List Price Per Unit The list price per unit at the time of transaction. This field is used for reporting purposes. The Amount Per Unit value is used to determine the charge amount for this order line item. If List Price Per Unit is not specified, Amount Per Unit will be used as the list price.
UOM Unit of measure. The UOM is defined in Billing settings
Amount Per Unit Required field. The amount that is charged per unit excluding discounts. This field can contain tax for tax inclusive.
Quantity Quantity of the order line item to be purchased. The charge amount will be calculated based on the specified Quantity and Amount Per Unit values. When this field is specified, each unit must be identical and you cannot modify a unit individually. To have a different unit, create another order line item.
Sold To Contact First Name

Use this section to specify the information about the Sold To Contact for this order line item. You have three options:

  • Leave this section empty by keeping the Use Billing Contact toggle button turned on. The default Sold To Contact under the invoice owner account of this order line item will be used as the Sold To Contact for this order line item.
  • Create a new contact as the Sold To Contact for this order line item by filling in the relevant fields. To edit the relevant fields, you must first turn the Use Billing Contact toggle button off.
  • Use an existing contact of the customer account by filling in the relevant fields. To edit the relevant fields, you must first turn the Use Billing Contact toggle button off.
Last Name
Country
State
City
County
Postal Code
Address 1
Address 2
Tax Tax Mode Indicates whether the charge amount is tax inclusive or tax exclusive.
Tax Code The tax code that is used to identify the appropriate tax rules and rates to apply to this order.
Finance Revenue Recognition Rule Name of the applicable revenue recognition rule.
Recognized Revenue Accounting Code The accounting code for recognized revenue.
Deferred Revenue Accounting Code The accounting code for deferred revenue.
Additional Information The custom fields that are defined on the Order Line Item object.

Use the REST API

You can use the Create an order operation to create an order line item with a new subscription.

To create an order line item with a new subscription:

  1. Determine the mandatory fields you will need for creating an order, including:
    • The following fields for a subscription: 
      • orderDate
      • productRatePlanId
      • existingAccountNumber

        You can also create both a subscription and a new account at the same time. In this case, you need to provide several other fields instead of existingAccountNumber. See Create an order for details.

    • The following fields and other required custom fields for order line items:
      • itemName
      • itemType
      • itemState
      • amountPerUnit

    These fields are a minimal set of fields required for an order. You can configure other optional fields based on your business needs.

  2. Use the "Create an order" operation to create an order.  

The following sample API request creates a subscription and two order line items under an existing account:

Request POST /v1/orders
Request Body
{
   "existingAccountNumber": "A00000002",
   "orderDate": "2021-04-27",
   "subscriptions": [
       {
         "orderActions": [
            {
              "type": "CreateSubscription",
              "triggerDates": [
                 {
                   "triggerDate": "$Today",
                   "name": "ContractEffective"
                 },
                 {
                   "triggerDate": "$Today",
                   "name": "ServiceActivation"
                 },
                 {
                   "triggerDate": "$Today",
                   "name": "CustomerAcceptance"
                 }
                ],
                "createSubscription": {
                  "terms": {
                     "autoRenew": false,
                     "renewalSetting": "RENEW_TO_EVERGREEN",
                     "initialTerm": {
                       "startDate": "$Today",
                       "period": 12,
                       "periodType": "Month",
                       "termType": "TERMED"
                     }
                  },
                  "subscribeToRatePlans": [
                    {
                      "productRatePlanId": "4028828c7a83d76f017a85747d4e1aec"
                    }
                  ]
                }
              }
           ]
       }
   ],
   "orderLineItems": [
      {
        "itemName": "LMS Training Fee",
        "itemType": "Product",
        "description": "webcam",
        "purchaseOrderNumber": "PO-12345678",
        "productCode": "P-0000001",
        "quantity": 10,
        "amountPerUnit": 499,
        "listPricePerUnit": 50,
        "transactionDate": "2021-02-01",
        "itemState": "SentToBilling",
        "billTargetDate": "2021-02-01"
      },
      {
        "itemName": "delivery fee",
        "itemType": "Fee",
        "description": "delivery fee",
        "purchaseOrderNumber": "PO-12345678",
        "productCode": "F-0000001",
        "quantity": 1,
        "amountPerUnit": 12.95,
        "listPricePerUnit": 12.95,
        "transactionDate": "2021-02-01",
        "itemState": "SentToBilling",
        "billTargetDate": "2021-02-01",
        "customFields": {
           "Color__c": "black",
           "Mode__c": "scalar"
        }
      }
   ],
   "processingOptions": {
      "runBilling": true,
      "collectPayment": true
   }
}
   

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 new subscription, use the Preview an order operation.