The Nue Self-Service API allows customers to modify existing subscriptions through change orders. These modifications can include updating quantities, changing subscription terms, renewing subscriptions, coterminating multiple subscriptions, or canceling services, with multiple combinations allowed from a single API call.

How to Create Change OrdersCopied!

Required Information

To create a change order, you need:

• Asset Changes: Array of modifications to make to existing assets

• Asset Number: The unique identifier for each subscription being modified. This is the the name of the subscription, which always starts with “SUB-”.

• Change Type: The type of change to perform (UpdateQuantity, UpdateTerm, Renew, CoTerm, Cancel, ConvertFreeTrial)

• Change Parameters: Specific details required for the selected change type

Change Types and Parameters

The changeType field determines what action will be performed and what additional parameters are required:

• UpdateQuantity: Change the number of units

  Requires: quantity and startDate

• UpdateTerm: Change the subscription term

  Requires: term (duration in months)

• Renew: Renew the subscription

  Requires: renewalTerm and startDate

• CoTerm: Align the subscription end date with another date

  Requires: coTermDate

• Cancel: End the subscription

  Requires: cancellationDate

• ConvertFreeTrial: Convert a trial to a paid subscription

  Requires: startDate and term

Creating a Change Order Preview

The first step is to create a change order preview using the /change-orders endpoint. This creates a preview that shows pricing and impact without making actual changes.

Similar to New Order creation, the options to previewInvoice and calculateTax are available.

Change Order Preview

The preview response includes:

• Order details (total price, discounts, etc.)

• Order products (line items reflecting changes)

• Preview invoices (if requested)

• Calculate tax (if requested)

• Asset change summaries

• Pricing impacts (prorations, credits, new charges)

At this stage, the change order is in preview mode and has no financial impact until activated.

Pricing Summary

The change order preview includes detailed pricing information:

• todayChargeAmount: Amount to be charged immediately

• nextBillingPeriodAmount: Amount for the next billing cycle

• totalAmount: Total impact of the change

• Detailed breakdown of increases/decreases per line item