GuideReference

Order Activation

Order activation is the critical process that transforms draft orders (both new orders and change orders) into active, billable entities. This step finalizes customer intent and begins the fulfillment process.

Required Information

To activate an order, you need:

  • Draft Order ID: The unique identifier of the preview order to activate

  • Activation Options: Settings for invoice generation and activation

Activation Parameters

The activation request can include several optional parameters:

  • Generate Invoice: Whether to automatically generate invoices upon activation

  • Activate Invoice: Whether to automatically activate generated invoices

  • PO Number: Purchase order reference number for the customer's records

  • PO Date: Date of the purchase order

  • Transaction Hub: External system integration details, currently supporting Stripe

Activation Process

When you activate an order using the /orders/:activate endpoint, the system:

  1. Validates the draft order is eligible for activation

  2. Finalizes all pricing calculations

  3. Creates or updates subscription records

  4. Generates assets and entitlements

  5. Creates invoices (if requested)

  6. Syncs data with connected systems

Activation Response

The activation response includes:

  • Updated order status and details

  • Created assets and entitlements

  • Generated subscriptions

  • Invoice information (if generated)

  • Transaction details for external systems

Invoice Generation

During activation, if generateInvoice: true is specified, the system will:

  • Create detailed invoices based on the order details

  • Include all line items with appropriate taxes

  • Set the invoice status based on the activateInvoice parameter

  • Generate PDF documents for the invoices

  • Provide payment links (if integrated with payment systems)

Payment Processing

If the order is configured with payment methods and activateInvoice: true is set:

  • Invoice will be marked for immediate payment

  • Payment will be processed using the specified payment method

  • Payment status will be included in the response

External System Integration

The transactionHub parameter allows you to associate the order with external systems:

"transactionHub": {
    "externalSystem": "string",    // e.g., "Stripe", "Salesforce"
    "externalId": "string",        // ID in the external system
    "transactionType": "string"    // Type of transaction
}

This enables bidirectional synchronization between Nue and other systems in your technology stack.

Best Practices for Order ActivationCopied!

  • Always review the preview order before activation

  • Ensure all required information is complete

  • Consider implementing approval workflows for high-value orders

  • Set up notifications for successful activations

  • Provide clear confirmation to customers after activation

  • Store the order ID for future reference

By following these guidelines, you can create a smooth order activation process that ensures accurate fulfillment and billing while providing a positive customer experience.

© 2025 Nue.io