Invoice Preview

1 min

POST

https://api.nue.io/orders/invoice-preview

Computes invoice preview data for an initial order or change order without persisting any data. Use this endpoint to show customers what they will be billed before committing.

Two modes via a single endpoint:

Initial order preview: Include orderProducts to preview invoices for a new order. Accepts the same product fields as POST /orders.
Change order preview: Include assetChanges to preview invoices for modifications to existing subscriptions. Accepts the same change fields as POST /change-orders.

Exactly one of orderProducts or assetChanges must be present. The endpoint runs the full pricing engine (product resolution, bundle expansion, price tags, discounts) and returns computed invoices, but writes nothing to the database.

acceptstringGenerated from available response content types

bodyobject<p>Exactly one of 'orderProducts' (initial order) or 'assetChanges' (change order) must be present.</p>

200Invoice preview computed successfully. The response shape depends on the request type.

400Validation error

401Unauthorized

curl --request POST \
     --url https://api.nue.io/orders/invoice-preview \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customer": {
     "id": ""
     },
     "orderProducts": [
     {
     "priceBookEntryId": "",
     "quantity": "",
     "subscriptionStartDate": "",
     "addOns": [
     {
     "productOptionId": ""
     }
     ]
     }
     ],
     "assetChanges": [
     {
     "changeType": "",
     "assetNumber": "",
     "addOns": [
     {
     "productOptionId": "",
     "reconfigureEffectiveDate": "",
     "productOptionQuantity": ""
     }
     ]
     }
     ],
     "products": [
     {
     "priceBookEntryId": "",
     "quantity": "",
     "subscriptionStartDate": ""
     }
     ]
     }'