--- title: Create Draft Order slug: create-draft-order docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "FY_Z526yW5XX5Iz4H8t0I", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/orders", "servers": [ { "url": "https://api.nue.io/orders", "description": "**Production Environment** - Live production server for all customer-facing operations. Use this for production integrations with real customer data and transactions." }, { "url": "https://api.sandbox.nue.io/orders", "description": "**Sandbox Environment** - Safe testing environment with sample data for development and integration testing. No rate limits apply. Data is reset weekly. Perfect for prototyping and QA testing." } ], "name": "Create Draft Order", "description": "

This endpoint allows you to create a preview or draft order. You can configure bundles by using the addOns field to specify product options within the bundle. Add-ons can have their own quantities, subscription terms, and start dates.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "customer", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique identifier for the customer." } ] }, { "name": "effectiveDate", "kind": "required", "type": "string", "description": "

The effective date (ISO 8601 format, e.g., '2024-10-21').

" }, { "name": "orderProducts", "kind": "required", "type": "array", "description": "

List of products being ordered. For bundle products, you can specify add-ons using the addOns field to configure included or optional product options. Add-ons can be nested up to 3 levels deep (orderProducts → addOns → addOns), allowing for complex bundle hierarchies with sub-bundles and their own product options.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "priceBookEntryId", "kind": "required", "type": "string", "description": "The unique identifier for the price book entry." }, { "name": "quantity", "kind": "required", "type": "number", "description": "The quantity of the product being ordered." }, { "name": "subscriptionStartDate", "kind": "required", "type": "string", "description": "

The start date for the subscription (ISO 8601 format).

" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "The duration of the subscription in months." }, { "name": "coTermAsset", "kind": "optional", "type": "string", "description": "

Asset number (SUB-XXXXXX) of an existing subscription to align this new subscription's end date with. When specified, the subscriptionTerm field is not required as the coTerm field takes over defining the subscription term to match the subscription end date of the provided asset.

" }, { "name": "addOns", "kind": "optional", "type": "array", "description": "

Product options to configure for bundles. Can be used to configure both included (bundled=true) and optional product options. For each add-on, you must specify the productOptionId. If the add-on's quantity is editable (quantityEditable=true), you must provide productOptionQuantity. Add-ons can have their own subscription start dates and terms; if not provided, they inherit from the parent product. Add-ons can be nested up to 3 levels deep (orderProducts → addOns → addOns), allowing for complex bundle hierarchies. The system enforces validation rules including minimum/maximum quantity requirements, and required add-ons.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "productOptionId", "kind": "required", "type": "string", "description": "The unique identifier for the product option." }, { "name": "productOptionQuantity", "kind": "optional", "type": "number", "description": "The quantity of the product option. Required when quantity is editable." }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "

The start date for the add-on subscription (ISO 8601 format). Defaults to parent product's start date if not provided.

" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "

The duration of the add-on subscription in months. Defaults to parent product's term if not provided.

" }, { "name": "coTermAsset", "kind": "optional", "type": "string", "description": "

Asset number (SUB-XXXXXX) of an existing subscription to align this add-on's end date with. When specified, the subscriptionTerm field is not required for this add-on.

" }, { "name": "priceTagIds", "kind": "optional", "type": "array", "description": "

Array of price tag IDs applicable to the add-on.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTagCodes", "kind": "optional", "type": "array", "description": "

Array of price tag codes applicable to the add-on.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "paymentMethodObject", "kind": "optional", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "externalPaymentMethodId", "kind": "required", "type": "string", "description": "

External payment method ID (e.g., Stripe payment method ID)

" }, { "name": "name", "kind": "required", "type": "string", "description": "Display name for the payment method" }, { "name": "paymentMethodType", "kind": "required", "type": "string", "description": "Type of payment method", "enum": [ "Electronic", "NonElectronic", "ACH", "Bank Transfer", "Cash", "Check", "Credit Card", "Debit Card", "Paypal", "Wire Transfer", "Other" ] }, { "name": "paymentSystem", "kind": "required", "type": "string", "description": "

Payment system identifier (e.g., 'Stripe')

" }, { "name": "autoChargeEnabled", "kind": "required", "type": "boolean", "description": "Whether automatic charging is enabled" } ] }, { "name": "object", "description": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Existing Nue payment method ID" } ] } ], "schema": [] }, { "name": "addOns", "kind": "optional", "type": "array", "description": "

Nested product options for this add-on. Add-ons can be nested up to 3 levels deep (orderProducts → addOns → addOns). This allows for complex bundle configurations where add-ons themselves can have their own product options.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "productOptionId", "kind": "required", "type": "string", "description": "The unique identifier for the nested product option." }, { "name": "productOptionQuantity", "kind": "optional", "type": "number", "description": "The quantity of the nested product option. Required when quantity is editable." }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "

The start date for the nested add-on subscription (ISO 8601 format). Defaults to parent add-on's start date if not provided.

" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "

The duration of the nested add-on subscription in months. Defaults to parent add-on's term if not provided.

" }, { "name": "coTermAsset", "kind": "optional", "type": "string", "description": "

Asset number (SUB-XXXXXX) of an existing subscription to align this nested add-on's end date with. When specified, the subscriptionTerm field is not required for this nested add-on.

" }, { "name": "priceTagIds", "kind": "optional", "type": "array", "description": "

Array of price tag IDs applicable to the nested add-on.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTagCodes", "kind": "optional", "type": "array", "description": "

Array of price tag codes applicable to the nested add-on.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "paymentMethodObject", "kind": "optional", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "externalPaymentMethodId", "kind": "required", "type": "string", "description": "

External payment method ID (e.g., Stripe payment method ID)

" }, { "name": "name", "kind": "required", "type": "string", "description": "Display name for the payment method" }, { "name": "paymentMethodType", "kind": "required", "type": "string", "description": "Type of payment method", "enum": [ "Electronic", "NonElectronic", "ACH", "Bank Transfer", "Cash", "Check", "Credit Card", "Debit Card", "Paypal", "Wire Transfer", "Other" ] }, { "name": "paymentSystem", "kind": "required", "type": "string", "description": "

Payment system identifier (e.g., 'Stripe')

" }, { "name": "autoChargeEnabled", "kind": "required", "type": "boolean", "description": "Whether automatic charging is enabled" } ] }, { "name": "object", "description": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Existing Nue payment method ID" } ] } ], "schema": [] } ] } ] }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "Whether the subscription should automatically renew." }, { "name": "billCycleDay", "kind": "optional", "type": "string<1st of Month | 2nd of Month | 3rd of Month | 4th of Month | 5th of Month | 6th of Month | 7th of Month | 8th of Month | 9th of Month | 10th of Month | 11th of Month | 12th of Month | 13th of Month | 14th of Month | 15th of Month | 16th of Month | 17th of Month | 18th of Month | 19th of Month | 20th of Month | 21st of Month | 22nd of Month | 23rd of Month | 24th of Month | 25th of Month | 26th of Month | 27th of Month | 28th of Month | 29th of Month | 30th of Month | 31st of Month>", "description": "

The day of the month for billing (e.g., '1st of Month').

", "enum": [ "1st of Month", "2nd of Month", "3rd of Month", "4th of Month", "5th of Month", "6th of Month", "7th of Month", "8th of Month", "9th of Month", "10th of Month", "11th of Month", "12th of Month", "13th of Month", "14th of Month", "15th of Month", "16th of Month", "17th of Month", "18th of Month", "19th of Month", "20th of Month", "21st of Month", "22nd of Month", "23rd of Month", "24th of Month", "25th of Month", "26th of Month", "27th of Month", "28th of Month", "29th of Month", "30th of Month", "31st of Month" ] }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string<01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12>", "description": "

The month to start billing (e.g., '01' for January).

", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12" ] }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "

The billing period for the order (Month, Quarter, Semi-Annual, Annual, SameAsSubscriptionTerm).

", "enum": [ "Month", "Quarter", "Semi-Annual", "Annual", "SameAsSubscriptionTerm" ] }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "

When to bill (In Advance, In Arrears).

", "enum": [ "In Advance", "In Arrears" ] }, { "name": "carvesLiabilitySegment", "kind": "optional", "type": "string", "description": "The carves liability segment." }, { "name": "carvesRevenueSegment", "kind": "optional", "type": "string", "description": "The carves revenue segment." }, { "name": "carvesEligible", "kind": "optional", "type": "boolean", "description": "Whether the product is eligible for carves." }, { "name": "contractLiabilitySegment", "kind": "optional", "type": "string", "description": "The contract liability segment." }, { "name": "contractRevenueSegment", "kind": "optional", "type": "string", "description": "The contract revenue segment." }, { "name": "defaultRenewalTerm", "kind": "optional", "type": "number", "description": "The default term for renewal." }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of the order product." }, { "name": "entityId", "kind": "optional", "type": "string", "description": "The ID of the associated entity." }, { "name": "entityUseCode", "kind": "optional", "type": "string", "description": "The entity use code for tax purposes.", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "P", "Q", "R", "TAXABLE" ] }, { "name": "priceTagIds", "kind": "optional", "type": "array", "description": "Array of strings with applicable price tag IDs.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTagCodes", "kind": "optional", "type": "array", "description": "Array of strings with applicable price tag codes.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "paymentMethodObject", "kind": "optional", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "externalPaymentMethodId", "kind": "required", "type": "string", "description": "

External payment method ID (e.g., Stripe payment method ID)

" }, { "name": "name", "kind": "required", "type": "string", "description": "Display name for the payment method" }, { "name": "paymentMethodType", "kind": "required", "type": "string", "description": "Type of payment method", "enum": [ "Electronic", "NonElectronic", "ACH", "Bank Transfer", "Cash", "Check", "Credit Card", "Debit Card", "Paypal", "Wire Transfer", "Other" ] }, { "name": "paymentSystem", "kind": "required", "type": "string", "description": "

Payment system identifier (e.g., 'Stripe')

" }, { "name": "autoChargeEnabled", "kind": "required", "type": "boolean", "description": "Whether automatic charging is enabled" } ] }, { "name": "object", "description": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Existing Nue payment method ID" } ] } ], "schema": [] } ] }, { "name": "options", "kind": "required", "type": "object", "description": "

Configuration options for the order preview. For configuring bundles, use the 'addOns' field within each orderProduct to specify product options. Add-ons can have their own quantities, subscription start dates, and terms. If these values are not provided for an add-on, they inherit from the parent bundle. Nested bundles can be configured up to 3 levels deep.

", "example": "", "schema": [ { "name": "previewInvoice", "kind": "optional", "type": "boolean", "description": "Whether to generate preview invoices. Default is true." }, { "name": "calculateTax", "kind": "optional", "type": "boolean", "description": "Whether to calculate tax for the order. Default is false." } ] }, { "name": "billToContact", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "The unique identifier for the billing contac." } ] }, { "name": "shipToContact", "kind": "optional", "type": "string", "description": "The unique identifier for the shipping contact." }, { "name": "transactionHub", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "externalSystem", "kind": "optional", "type": "string", "description": "External system identifier." }, { "name": "externalId", "kind": "optional", "type": "string", "description": "External transaction identifier." }, { "name": "transactionType", "kind": "optional", "type": "string", "description": "Type of transaction." } ] }, { "name": "paymentMethodObject", "kind": "optional", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [ { "name": "object", "description": "", "schema": [ { "name": "externalPaymentMethodId", "kind": "required", "type": "string", "description": "

External payment method ID (e.g., Stripe payment method ID)

" }, { "name": "name", "kind": "required", "type": "string", "description": "Display name for the payment method" }, { "name": "paymentMethodType", "kind": "required", "type": "string", "description": "Type of payment method", "enum": [ "Electronic", "NonElectronic", "ACH", "Bank Transfer", "Cash", "Check", "Credit Card", "Debit Card", "Paypal", "Wire Transfer", "Other" ] }, { "name": "paymentSystem", "kind": "required", "type": "string", "description": "

Payment system identifier (e.g., 'Stripe')

" }, { "name": "autoChargeEnabled", "kind": "required", "type": "boolean", "description": "Whether automatic charging is enabled" } ] }, { "name": "object", "description": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Existing Nue payment method ID" } ] } ], "schema": [] }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "The unique identifier for the billing account." }, { "name": "billingAddress", "kind": "optional", "type": "string", "description": "The billing address for the order." }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "The billing period for the order.", "enum": [ "Month", "Quarter", "Semi-Annual", "Annual", "SameAsSubscriptionTerm" ] }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of the order." }, { "name": "entityUseCode", "kind": "optional", "type": "string", "description": "The entity use code for tax purposes.", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "P", "Q", "R", "TAXABLE" ] }, { "name": "opportunityId", "kind": "optional", "type": "string", "description": "The ID of the opportunity associated with this order." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the order." }, { "name": "ownerId", "kind": "optional", "type": "string", "description": "The ID of the order owner." }, { "name": "orderReferenceNumber", "kind": "optional", "type": "string", "description": "A reference number for the order." }, { "name": "orderType", "kind": "optional", "type": "string", "description": "The type of order." }, { "name": "poDate", "kind": "optional", "type": "string", "description": "

The purchase order date (ISO 8601 format).

", "format": "date" }, { "name": "poNumber", "kind": "optional", "type": "string", "description": "The purchase order number." }, { "name": "paymentMethod", "kind": "optional", "type": "string", "description": "The payment method for the order.", "enum": [ "Electronic", "NonElectronic", "ACH", "Bank Transfer", "Cash", "Check", "Credit Card", "Debit Card", "Paypal", "Wire Transfer", "Other" ] }, { "name": "paymentMethods", "kind": "optional", "type": "array", "description": "Multiple payment methods for the order.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "isShippingAddressSameAsBilling", "kind": "optional", "type": "boolean", "description": "Whether the shipping address is the same as the billing address." }, { "name": "shippingAddress", "kind": "optional", "type": "string", "description": "The shipping address for the order." } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Order preview created successfully", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "

The status of the request (SUCCESS or ERROR).

" }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "assets", "kind": "optional", "type": "array", "description": "List of assets related to the order.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "List of entitlements associated with the order.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "order", "kind": "optional", "type": "object", "description": "

Represents a booking transaction between a company and a customer to provision services or deliver products with contracted quantities, prices, and terms.

", "example": "", "schema": [ { "name": "activatedById", "kind": "optional", "type": "string", "description": "ID of the user who activated this order." }, { "name": "activatedDate", "kind": "optional", "type": "string", "description": "Date and time when the order was activated.", "format": "date-time" }, { "name": "billCycleDay", "kind": "optional", "type": "string<1st of Month | 2nd of Month | 3rd of Month | 4th of Month | 5th of Month | 6th of Month | 7th of Month | 8th of Month | 9th of Month | 10th of Month | 11th of Month | 12th of Month | 13th of Month | 14th of Month | 15th of Month | 16th of Month | 17th of Month | 18th of Month | 19th of Month | 20th of Month | 21st of Month | 22nd of Month | 23rd of Month | 24th of Month | 25th of Month | 26th of Month | 27th of Month | 28th of Month | 29th of Month | 30th of Month | 31st of Month>", "description": "The day of the month for billing.", "default": "1st of Month", "enum": [ "1st of Month", "2nd of Month", "3rd of Month", "4th of Month", "5th of Month", "6th of Month", "7th of Month", "8th of Month", "9th of Month", "10th of Month", "11th of Month", "12th of Month", "13th of Month", "14th of Month", "15th of Month", "16th of Month", "17th of Month", "18th of Month", "19th of Month", "20th of Month", "21st of Month", "22nd of Month", "23rd of Month", "24th of Month", "25th of Month", "26th of Month", "27th of Month", "28th of Month", "29th of Month", "30th of Month", "31st of Month" ] }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "The ID of the contact to bill." }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "The ID of the billing account." }, { "name": "billingAddress", "kind": "optional", "type": "string", "description": "The billing address for the order." }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "The billing period for the order.", "default": "Month", "enum": [ "Month", "Quarter", "Semi-Annual", "Annual", "SameAsSubscriptionTerm" ] }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "The date when the order was cancelled.", "format": "date" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "The ID of the customer." }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the order." }, { "name": "discount", "kind": "optional", "type": "number", "description": "The discount applied to the order." }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Total discount amount applied to the order." }, { "name": "endDate", "kind": "optional", "type": "string", "description": "The end date of the order.", "format": "date" }, { "name": "entityUseCode", "kind": "optional", "type": "string", "description": "The entity use code for tax purposes.", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "P", "Q", "R", "TAXABLE" ] }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the order." }, { "name": "isShippingAddressSameAsBilling", "kind": "optional", "type": "boolean", "description": "Indicates if the shipping address is the same as the billing address." }, { "name": "listTotal", "kind": "optional", "type": "number", "description": "Total list price of all products in the order." }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the order.", "maxLength": 80 }, { "name": "orderNumber", "kind": "optional", "type": "string", "description": "

Auto-generated order number.

" }, { "name": "orderStartDate", "kind": "optional", "type": "string", "description": "The effective date of the order.", "format": "date" }, { "name": "paymentMethod", "kind": "optional", "type": "string", "description": "The payment method for the order.", "default": "None", "enum": [ "Electronic", "NonElectronic", "ACH", "Bank Transfer", "Cash", "Check", "Credit Card", "Debit Card", "Paypal", "Wire Transfer", "Other" ] }, { "name": "poDate", "kind": "optional", "type": "string", "description": "The purchase order date.", "format": "date" }, { "name": "poNumber", "kind": "optional", "type": "string", "description": "The purchase order number.", "maxLength": 80 }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "The ID of the price book used for the order." }, { "name": "shipToContactId", "kind": "optional", "type": "string", "description": "The ID of the contact to ship to." }, { "name": "shippingAddress", "kind": "optional", "type": "string", "description": "The shipping address for the order." }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the order.", "default": "Draft", "enum": [ "Draft", "Activated", "Canceled" ] }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "Subtotal before discounts and taxes." }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "

System-level discount percentage applied to the order.

" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "

Amount of system-level discount applied.

" }, { "name": "tax", "kind": "optional", "type": "number", "description": "Tax amount applied to the order." }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total amount after discounts and taxes." }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Total price of the order." } ] }, { "name": "orderProducts", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "actualQuantity", "kind": "optional", "type": "number", "description": "The actual quantity ordered." }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "Whether the subscription automatically renews." }, { "name": "billCycleDay", "kind": "optional", "type": "string<1st of Month | 2nd of Month | 3rd of Month | 4th of Month | 5th of Month | 6th of Month | 7th of Month | 8th of Month | 9th of Month | 10th of Month | 11th of Month | 12th of Month | 13th of Month | 14th of Month | 15th of Month | 16th of Month | 17th of Month | 18th of Month | 19th of Month | 20th of Month | 21st of Month | 22nd of Month | 23rd of Month | 24th of Month | 25th of Month | 26th of Month | 27th of Month | 28th of Month | 29th of Month | 30th of Month | 31st of Month>", "description": "The day of the month for billing.", "enum": [ "1st of Month", "2nd of Month", "3rd of Month", "4th of Month", "5th of Month", "6th of Month", "7th of Month", "8th of Month", "9th of Month", "10th of Month", "11th of Month", "12th of Month", "13th of Month", "14th of Month", "15th of Month", "16th of Month", "17th of Month", "18th of Month", "19th of Month", "20th of Month", "21st of Month", "22nd of Month", "23rd of Month", "24th of Month", "25th of Month", "26th of Month", "27th of Month", "28th of Month", "29th of Month", "30th of Month", "31st of Month" ] }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string<01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12>", "description": "The month to start billing.", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12" ] }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "The billing period for the order.", "enum": [ "Month", "Quarter", "Semi-Annual", "Annual", "SameAsSubscriptionTerm" ] }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Determines whether customers are billed before or after services are provided.", "enum": [ "In Advance", "In Arrears" ] }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "The date when the order product was cancelled.", "format": "date" }, { "name": "carvesEligible", "kind": "optional", "type": "boolean", "description": "Whether the product is eligible for carves." }, { "name": "carvesLiabilitySegment", "kind": "optional", "type": "string", "description": "The carves liability segment." }, { "name": "carvesRevenueSegment", "kind": "optional", "type": "string", "description": "The carves revenue segment." }, { "name": "contractLiabilitySegment", "kind": "optional", "type": "string", "description": "The contract liability segment." }, { "name": "contractRevenueSegment", "kind": "optional", "type": "string", "description": "The contract revenue segment." }, { "name": "customerId", "kind": "optional", "type": "string", "description": "The ID of the customer." }, { "name": "defaultRenewalTerm", "kind": "optional", "type": "number", "description": "The default term for renewal." }, { "name": "deltaACV", "kind": "optional", "type": "number", "description": "Delta Annual Contract Value." }, { "name": "deltaARR", "kind": "optional", "type": "number", "description": "Delta Annual Recurring Revenue." }, { "name": "deltaCMRR", "kind": "optional", "type": "number", "description": "Delta Committed Monthly Recurring Revenue." }, { "name": "deltaTCV", "kind": "optional", "type": "number", "description": "Delta Total Contract Value." }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of the order product." }, { "name": "discount", "kind": "optional", "type": "number", "description": "Discount percentage applied to the order product." }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Discount amount applied to the order product." }, { "name": "entityId", "kind": "optional", "type": "string", "description": "The ID of the associated entity." }, { "name": "entityUseCode", "kind": "optional", "type": "string", "description": "The entity use code for tax purposes.", "enum": [ "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "P", "Q", "R", "TAXABLE" ] }, { "name": "evergreen", "kind": "optional", "type": "boolean", "description": "Indicates if the product is evergreen." }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the order product." }, { "name": "lineType", "kind": "optional", "type": "string", "description": "Type of line item.", "enum": [ "LineItem", "RampItem", "SummaryItem", "ChangeItem", "SplitItem" ] }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "List price for the order product." }, { "name": "listTotalPrice", "kind": "optional", "type": "number", "description": "Total list price for the order product." }, { "name": "name", "kind": "optional", "type": "string", "description": "Order Product Number." }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "Net sales price for the order product." }, { "name": "orderId", "kind": "optional", "type": "string", "description": "The ID of the order." }, { "name": "parentOrderProductId", "kind": "optional", "type": "string", "description": "The ID of the parent order product." }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "The ID of the price book entry." }, { "name": "productId", "kind": "optional", "type": "string", "description": "The ID of the product." }, { "name": "productName", "kind": "optional", "type": "string", "description": "The name of the product." }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Quantity of the product ordered." }, { "name": "rootOrderProductId", "kind": "optional", "type": "string", "description": "Root order product ID." }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "

The unit sales price before on-the-fly discounts.

" }, { "name": "sku", "kind": "optional", "type": "string", "description": "The SKU of the product." }, { "name": "sortOrder", "kind": "optional", "type": "integer", "description": "Sort order for the order product." }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the order product." }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "End date for the subscription.", "format": "date" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "Start date for the subscription.", "format": "date" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Duration of the subscription." }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "Subtotal for the order product." }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "

System-level discount percentage for the order product.

" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "

Amount of system-level discount for the order product.

" }, { "name": "tax", "kind": "optional", "type": "number", "description": "Tax amount for the order product." }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total amount for the order product." }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Total price for the order product." }, { "name": "uom", "kind": "optional", "type": "string", "description": "The unit of measure name." }, { "name": "uomId", "kind": "optional", "type": "string", "description": "ID of the unit of measure." } ] }, { "name": "previewInvoices", "kind": "optional", "type": "array", "description": "

Returned when options.previewInvoice is true (the default). Contains the first invoice the order will generate, not every invoice over the term. Preview invoices never include tax (taxAmount is 0 and taxStatus is NotCalculated); calculated tax is on order.tax. The first invoice covers the whole term only on aligned annual billing in advance; otherwise it covers the first (possibly partial) billing period.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "accountEx", "kind": "optional", "type": "string", "description": "Account information in JSON format." }, { "name": "accountId", "kind": "optional", "type": "string", "description": "The ID of the account." }, { "name": "accountingStatus", "kind": "optional", "type": "string", "description": "

Indicates whether the invoice was transferred to an external accounting system (Not Started, Complete, Error, Skipped).

" }, { "name": "amount", "kind": "optional", "type": "number", "description": "The sum of all invoice items' amount including product and service charges as well as taxes." }, { "name": "amountWithoutTax", "kind": "optional", "type": "number", "description": "

The sum of all invoice items' amount, with tax excluded.

" }, { "name": "balance", "kind": "optional", "type": "number", "description": "

The remaining balance of the invoice after all payments, adjustments, and refunds are applied.

" }, { "name": "dueDate", "kind": "optional", "type": "string", "description": "Invoice Due Date.", "format": "date" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "

End Date of the billable period, where charges to be billed.

", "format": "date" }, { "name": "groupKey", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "BillingAccount", "kind": "optional", "type": "string", "description": "Billing account information." } ] }, { "name": "invoiceDate", "kind": "optional", "type": "string", "description": "Date of the invoice.", "format": "date" }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "description": "The ID of the billing account." }, { "name": "groupKey", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "BillingAccount", "kind": "optional", "type": "string", "description": "Billing account information." } ] }, { "name": "recordType", "kind": "optional", "type": "string", "description": "

Type of record (Invoice).

" }, { "name": "productId", "kind": "optional", "type": "string", "description": "The ID of the product." }, { "name": "productName", "kind": "optional", "type": "string", "description": "The product name." }, { "name": "assetId", "kind": "optional", "type": "string", "description": "The ID of the asset." }, { "name": "assetNumber", "kind": "optional", "type": "string", "description": "The asset number." }, { "name": "assetType", "kind": "optional", "type": "string", "description": "Type of asset.", "enum": [ "Subscription", "Asset", "Entitlement" ] }, { "name": "uomId", "kind": "optional", "type": "string", "description": "ID of the unit of measure." }, { "name": "transactionDate", "kind": "optional", "type": "string", "description": "The Invoice Date.", "format": "date" }, { "name": "transactionAmount", "kind": "optional", "type": "number", "description": "The amount being charged for the invoice item. This amount doesn't include taxes." }, { "name": "transactionQuantity", "kind": "optional", "type": "number", "description": "The quantity of the transaction." }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "Shipping and handling charges." }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "The tax amount for the transaction." }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "Net sales price for the transaction." }, { "name": "startDate", "kind": "optional", "type": "string", "description": "The start date of the billable period.", "format": "date" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "The end date of the billable period.", "format": "date" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "The billing timing of the associated product.", "enum": [ "In Advance", "In Arrears" ] }, { "name": "status", "kind": "optional", "type": "string", "description": "Status of the transaction." }, { "name": "taxStatus", "kind": "optional", "type": "string", "description": "Tax status of the transaction." } ] }, { "name": "paymentMethods", "kind": "optional", "type": "array", "description": "List of payment methods.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "recordType", "kind": "optional", "type": "string", "description": "

Type of record (Invoice).

" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "Shipping and handling charges." }, { "name": "startDate", "kind": "optional", "type": "string", "description": "

Start Date of the billable period, where charges are to be billed.

", "format": "date" }, { "name": "status", "kind": "optional", "type": "string", "description": "The invoice status.", "enum": [ "Draft", "Active", "Canceled", "PendingActivation", "E-Invoicing" ] }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "The sum of all invoice items' tax amount." }, { "name": "taxStatus", "kind": "optional", "type": "string", "description": "

The tax computation status (Not Calculated, Calculated, Error).

" } ] }, { "name": "subscriptions", "kind": "optional", "type": "array", "description": "

List of subscriptions related to the order (if any).

", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "Any warnings generated during the order preview process.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Warning code" }, { "name": "message", "kind": "optional", "type": "string", "description": "Warning message" } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request due to invalid input parameters", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Bad request due to invalid input parameters\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "label": "invalidAddonHierarchy", "code": "// Invalid Add-on Hierarchy\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_ADDON_HIERARCHY\",\n \"message\": \"Invalid add-on: Product option po-12345 is not available at this level in the product hierarchy\"\n}" }, { "label": "invalidAddonQuantity", "code": "// Invalid Add-on Quantity\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_ADDON_QUANTITY\",\n \"message\": \"Add-on quantity (3) is below minimum quantity (5) for option po-12345: Premium Feature\"\n}" }, { "label": "missingAddonQuantity", "code": "// Missing Add-on Quantity\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"MISSING_ADDON_QUANTITY\",\n \"message\": \"Product option quantity must be specified for editable add-on po-12345: Premium Feature\"\n}" }, { "label": "invalidAddonStartDate", "code": "// Invalid Add-on Start Date\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_ADDON_START_DATE\",\n \"message\": \"Add-on option po-12345: Premium Feature start date (2026-01-01) cannot be after parent's end date (2025-12-31)\"\n}" }, { "label": "subscriptionTermNotAllowed", "code": "// Subscription Term Not Allowed\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"SUBSCRIPTION_TERM_NOT_ALLOWED\",\n \"message\": \"Subscription term is not allowed for evergreen add-on product: Premium Feature\"\n}" }, { "label": "insufficientFeatureOptions", "code": "// Insufficient Feature Options\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INSUFFICIENT_FEATURE_OPTIONS\",\n \"message\": \"Product group Advanced Features requires at least 2 options, but only 1 were selected\"\n}" }, { "label": "excessiveFeatureOptions", "code": "// Excessive Feature Options\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"EXCESSIVE_FEATURE_OPTIONS\",\n \"message\": \"Product group Basic Features allows a maximum of 3 options, but 4 were selected\"\n}" }, { "label": "missingRequiredAddons", "code": "// Missing Required Add-ons\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"MISSING_REQUIRED_ADDONS\",\n \"message\": \"Missing required add-ons: Core Module, Authentication Module\"\n}" }, { "label": "duplicateProductOptions", "code": "// Duplicate Product Options\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"DUPLICATE_PRODUCT_OPTIONS\",\n \"message\": \"Duplicate product options found: po-12345. Each product option can only be added once.\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "Indicates the request failed", "enum": [ "FAILURE" ] }, { "name": "errorType", "kind": "optional", "type": "string", "description": "The type of error that occurred" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "A specific error code for the issue" }, { "name": "message", "kind": "optional", "type": "string", "description": "

A human-readable error message

" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "zED93mU5lcmD6T4zNiD5D", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/orders \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"customer\": {\n \"id\": \"\"\n },\n \"effectiveDate\": \"\",\n \"orderProducts\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n },\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ]\n }\n ],\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ],\n \"options\": {},\n \"billToContact\": {\n \"id\": \"\"\n },\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }'" }, { "id": "iyQMzPCGi4nsEcDioomXV", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"customer\": {\n \"id\": \"\"\n },\n \"effectiveDate\": \"\",\n \"orderProducts\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n },\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ]\n }\n ],\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ],\n \"options\": {},\n \"billToContact\": {\n \"id\": \"\"\n },\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/orders\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "GaTPrSld7qIBomrDmO3oS", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/orders\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"customer\": {\n \"id\": \"\"\n },\n \"effectiveDate\": \"\",\n \"orderProducts\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n },\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ]\n }\n ],\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ],\n \"options\": {},\n \"billToContact\": {\n \"id\": \"\"\n },\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "ASUQfZnEhonZdL6cy3gJf", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/orders\"\n\npayload = json.dumps({\n \"customer\": {\n \"id\": \"\"\n },\n \"effectiveDate\": \"\",\n \"orderProducts\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n },\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ]\n }\n ],\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }\n ],\n \"options\": {},\n \"billToContact\": {\n \"id\": \"\"\n },\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "zED93mU5lcmD6T4zNiD5D" }, "results": { "languages": [ { "id": "iDW4-SuLPxsdao9XAxBHx", "language": "201", "code": "// Order preview created successfully\n{\n \"status\": \"\",\n \"data\": {\n \"assets\": [\n {}\n ],\n \"entitlements\": [\n {}\n ],\n \"order\": {\n \"activatedById\": \"\",\n \"activatedDate\": \"\",\n \"billCycleDay\": \"\",\n \"billToContactId\": \"\",\n \"billingAccountId\": \"\",\n \"billingAddress\": \"\",\n \"billingPeriod\": \"\",\n \"cancellationDate\": \"\",\n \"customerId\": \"\",\n \"description\": \"\",\n \"discount\": 0,\n \"discountAmount\": 0,\n \"endDate\": \"\",\n \"entityUseCode\": \"\",\n \"id\": \"\",\n \"isShippingAddressSameAsBilling\": false,\n \"listTotal\": 0,\n \"name\": \"\",\n \"orderNumber\": \"\",\n \"orderStartDate\": \"\",\n \"paymentMethod\": \"\",\n \"poDate\": \"\",\n \"poNumber\": \"\",\n \"priceBookId\": \"\",\n \"shipToContactId\": \"\",\n \"shippingAddress\": \"\",\n \"status\": \"\",\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"tax\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0\n },\n \"orderProducts\": [\n {\n \"actualQuantity\": 0,\n \"autoRenew\": false,\n \"billCycleDay\": \"\",\n \"billCycleStartMonth\": \"\",\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"carvesEligible\": false,\n \"carvesLiabilitySegment\": \"\",\n \"carvesRevenueSegment\": \"\",\n \"contractLiabilitySegment\": \"\",\n \"contractRevenueSegment\": \"\",\n \"customerId\": \"\",\n \"defaultRenewalTerm\": 0,\n \"deltaACV\": 0,\n \"deltaARR\": 0,\n \"deltaCMRR\": 0,\n \"deltaTCV\": 0,\n \"description\": \"\",\n \"discount\": 0,\n \"discountAmount\": 0,\n \"entityId\": \"\",\n \"entityUseCode\": \"\",\n \"evergreen\": false,\n \"id\": \"\",\n \"lineType\": \"\",\n \"listPrice\": 0,\n \"listTotalPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderId\": \"\",\n \"parentOrderProductId\": \"\",\n \"priceBookEntryId\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"quantity\": 0,\n \"rootOrderProductId\": \"\",\n \"salesPrice\": 0,\n \"sku\": \"\",\n \"sortOrder\": 0,\n \"status\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"tax\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"uom\": \"\",\n \"uomId\": \"\"\n }\n ],\n \"previewInvoices\": [\n {\n \"accountEx\": \"\",\n \"accountId\": \"\",\n \"accountingStatus\": \"\",\n \"amount\": 0,\n \"amountWithoutTax\": 0,\n \"balance\": 0,\n \"dueDate\": \"\",\n \"endDate\": \"\",\n \"groupKey\": {\n \"BillingAccount\": \"\"\n },\n \"invoiceDate\": \"\",\n \"items\": [\n {\n \"accountId\": \"\",\n \"groupKey\": {\n \"BillingAccount\": \"\"\n },\n \"recordType\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"assetId\": \"\",\n \"assetNumber\": \"\",\n \"assetType\": \"\",\n \"uomId\": \"\",\n \"transactionDate\": \"\",\n \"transactionAmount\": 0,\n \"transactionQuantity\": 0,\n \"shippingAndHandling\": 0,\n \"taxAmount\": 0,\n \"netSalesPrice\": 0,\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"billingTiming\": \"\",\n \"status\": \"\",\n \"taxStatus\": \"\"\n }\n ],\n \"paymentMethods\": [\n \"\"\n ],\n \"recordType\": \"\",\n \"shippingAndHandling\": 0,\n \"startDate\": \"\",\n \"status\": \"\",\n \"taxAmount\": 0,\n \"taxStatus\": \"\"\n }\n ],\n \"subscriptions\": [\n {}\n ]\n },\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "1MKA0QqLzy6otN_Z0Hs51", "language": "400", "code": "// Bad request due to invalid input parameters\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// Bad request due to invalid input parameters\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "label": "invalidAddonHierarchy", "code": "// Invalid Add-on Hierarchy\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_ADDON_HIERARCHY\",\n \"message\": \"Invalid add-on: Product option po-12345 is not available at this level in the product hierarchy\"\n}" }, { "label": "invalidAddonQuantity", "code": "// Invalid Add-on Quantity\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_ADDON_QUANTITY\",\n \"message\": \"Add-on quantity (3) is below minimum quantity (5) for option po-12345: Premium Feature\"\n}" }, { "label": "missingAddonQuantity", "code": "// Missing Add-on Quantity\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"MISSING_ADDON_QUANTITY\",\n \"message\": \"Product option quantity must be specified for editable add-on po-12345: Premium Feature\"\n}" }, { "label": "invalidAddonStartDate", "code": "// Invalid Add-on Start Date\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_ADDON_START_DATE\",\n \"message\": \"Add-on option po-12345: Premium Feature start date (2026-01-01) cannot be after parent's end date (2025-12-31)\"\n}" }, { "label": "subscriptionTermNotAllowed", "code": "// Subscription Term Not Allowed\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"SUBSCRIPTION_TERM_NOT_ALLOWED\",\n \"message\": \"Subscription term is not allowed for evergreen add-on product: Premium Feature\"\n}" }, { "label": "insufficientFeatureOptions", "code": "// Insufficient Feature Options\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INSUFFICIENT_FEATURE_OPTIONS\",\n \"message\": \"Product group Advanced Features requires at least 2 options, but only 1 were selected\"\n}" }, { "label": "excessiveFeatureOptions", "code": "// Excessive Feature Options\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"EXCESSIVE_FEATURE_OPTIONS\",\n \"message\": \"Product group Basic Features allows a maximum of 3 options, but 4 were selected\"\n}" }, { "label": "missingRequiredAddons", "code": "// Missing Required Add-ons\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"MISSING_REQUIRED_ADDONS\",\n \"message\": \"Missing required add-ons: Core Module, Authentication Module\"\n}" }, { "label": "duplicateProductOptions", "code": "// Duplicate Product Options\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"DUPLICATE_PRODUCT_OPTIONS\",\n \"message\": \"Duplicate product options found: po-12345. Each product option can only be added once.\"\n}" } ] } ], "selectedLanguageId": "iDW4-SuLPxsdao9XAxBHx" } }, "children": [ { "text": "" } ] }