Create Draft Order
1 min
POST
https://api.nue.io/orders
Body Parameters
- bodyobjectrequired
- customerobjectrequired
- idstringrequiredDescription
- effectiveDatestringrequiredDescription
- orderProductsobject[]requiredDescription
- priceBookEntryIdstringrequiredDescription
- quantitynumberrequiredDescription
- subscriptionStartDatestringrequiredDescription
- subscriptionTermnumberDescription
- coTermAssetstringDescription
- addOnsobject[]Description
- productOptionIdstringrequiredDescription
- productOptionQuantitynumberDescription
- subscriptionStartDatestringDescription
- subscriptionTermnumberDescription
- coTermAssetstringDescription
- priceTagIdsstring[]Description
- priceTagCodesstring[]Description
- paymentMethodObjectobject
- object
- externalPaymentMethodIdstringrequiredDescription
- namestringrequiredDescription
- paymentMethodTypestring<Electronic | NonElectronic | ACH | Bank Transfer | Cash | Check | Credit Card | Debit Card | Paypal | Wire Transfer | Other>requiredDescriptionAllowedElectronicNonElectronicACHBank TransferCashCheckCredit CardDebit CardPaypalWire TransferOther
- paymentSystemstringrequiredDescription
- autoChargeEnabledbooleanrequiredDescription
- object
- idstringrequiredDescription
- addOnsobject[]Description
- productOptionIdstringrequiredDescription
- productOptionQuantitynumberDescription
- subscriptionStartDatestringDescription
- subscriptionTermnumberDescription
- coTermAssetstringDescription
- priceTagIdsstring[]Description
- priceTagCodesstring[]Description
- paymentMethodObjectobject
- object
- externalPaymentMethodIdstringrequiredDescription
- namestringrequiredDescription
- paymentMethodTypestring<Electronic | NonElectronic | ACH | Bank Transfer | Cash | Check | Credit Card | Debit Card | Paypal | Wire Transfer | Other>requiredDescriptionAllowedElectronicNonElectronicACHBank TransferCashCheckCredit CardDebit CardPaypalWire TransferOther
- paymentSystemstringrequiredDescription
- autoChargeEnabledbooleanrequiredDescription
- object
- idstringrequiredDescription
- autoRenewbooleanDescription
- billCycleDaystring<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>DescriptionAllowed1st of Month2nd of Month3rd of Month4th of Month5th of Month6th of Month7th of Month8th of Month9th of Month10th of Month11th of Month12th of Month13th of Month14th of Month15th of Month16th of Month17th of Month18th of Month19th of Month20th of Month21st of Month22nd of Month23rd of Month24th of Month25th of Month26th of Month27th of Month28th of Month29th of Month30th of Month31st of Month
- billCycleStartMonthstring<01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12>DescriptionAllowed010203040506070809101112
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual | SameAsSubscriptionTerm>DescriptionAllowedMonthQuarterSemi-AnnualAnnualSameAsSubscriptionTerm
- billingTimingstring<In Advance | In Arrears>DescriptionAllowedIn AdvanceIn Arrears
- carvesLiabilitySegmentstringDescription
- carvesRevenueSegmentstringDescription
- carvesEligiblebooleanDescription
- contractLiabilitySegmentstringDescription
- contractRevenueSegmentstringDescription
- defaultRenewalTermnumberDescription
- descriptionstringDescription
- entityIdstringDescription
- entityUseCodestring<A | B | C | D | E | F | G | H | I | J | K | L | M | N | P | Q | R | TAXABLE>DescriptionAllowedABCDEFGHIJKLMNPQRTAXABLE
- priceTagIdsstring[]Description
- priceTagCodesstring[]Description
- paymentMethodObjectobject
- object
- externalPaymentMethodIdstringrequiredDescription
- namestringrequiredDescription
- paymentMethodTypestring<Electronic | NonElectronic | ACH | Bank Transfer | Cash | Check | Credit Card | Debit Card | Paypal | Wire Transfer | Other>requiredDescriptionAllowedElectronicNonElectronicACHBank TransferCashCheckCredit CardDebit CardPaypalWire TransferOther
- paymentSystemstringrequiredDescription
- autoChargeEnabledbooleanrequiredDescription
- object
- idstringrequiredDescription
- optionsobjectrequiredDescription
- previewInvoicebooleanDescription
- calculateTaxbooleanDescription
- billToContactobject
- idstringrequiredDescription
- shipToContactstringDescription
- transactionHubobject
- externalSystemstringDescription
- externalIdstringDescription
- transactionTypestringDescription
- paymentMethodObjectobject
- object
- externalPaymentMethodIdstringrequiredDescription
- namestringrequiredDescription
- paymentMethodTypestring<Electronic | NonElectronic | ACH | Bank Transfer | Cash | Check | Credit Card | Debit Card | Paypal | Wire Transfer | Other>requiredDescriptionAllowedElectronicNonElectronicACHBank TransferCashCheckCredit CardDebit CardPaypalWire TransferOther
- paymentSystemstringrequiredDescription
- autoChargeEnabledbooleanrequiredDescription
- object
- idstringrequiredDescription
- billingAccountIdstringDescription
- billingAddressstringDescription
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual | SameAsSubscriptionTerm>DescriptionAllowedMonthQuarterSemi-AnnualAnnualSameAsSubscriptionTerm
- descriptionstringDescription
- entityUseCodestring<A | B | C | D | E | F | G | H | I | J | K | L | M | N | P | Q | R | TAXABLE>DescriptionAllowedABCDEFGHIJKLMNPQRTAXABLE
- opportunityIdstringDescription
- namestringDescription
- ownerIdstringDescription
- orderReferenceNumberstringDescription
- orderTypestringDescription
- poDatestring<date>DescriptionFormatdate
- poNumberstringDescription
- paymentMethodstring<Electronic | NonElectronic | ACH | Bank Transfer | Cash | Check | Credit Card | Debit Card | Paypal | Wire Transfer | Other>DescriptionAllowedElectronicNonElectronicACHBank TransferCashCheckCredit CardDebit CardPaypalWire TransferOther
- paymentMethodsstring[]Description
- isShippingAddressSameAsBillingbooleanDescription
- shippingAddressstringDescription
Responses
201
- object
- statusstringDescription
- dataobject
- assetsobject[]Description
- entitlementsobject[]Description
- orderobjectDescription
- activatedByIdstringDescription
- activatedDatestring<date-time>DescriptionFormatdate-time
- billCycleDaystring<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>DescriptionDefault1st of MonthAllowed1st of Month2nd of Month3rd of Month4th of Month5th of Month6th of Month7th of Month8th of Month9th of Month10th of Month11th of Month12th of Month13th of Month14th of Month15th of Month16th of Month17th of Month18th of Month19th of Month20th of Month21st of Month22nd of Month23rd of Month24th of Month25th of Month26th of Month27th of Month28th of Month29th of Month30th of Month31st of Month
- billToContactIdstringDescription
- billingAccountIdstringDescription
- billingAddressstringDescription
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual | SameAsSubscriptionTerm>DescriptionDefaultMonthAllowedMonthQuarterSemi-AnnualAnnualSameAsSubscriptionTerm
- cancellationDatestring<date>DescriptionFormatdate
- customerIdstringDescription
- descriptionstringDescription
- discountnumberDescription
- discountAmountnumberDescription
- endDatestring<date>DescriptionFormatdate
- entityUseCodestring<A | B | C | D | E | F | G | H | I | J | K | L | M | N | P | Q | R | TAXABLE>DescriptionAllowedABCDEFGHIJKLMNPQRTAXABLE
- idstringDescription
- isShippingAddressSameAsBillingbooleanDescription
- listTotalnumberDescription
- namestringDescriptionMax Length80
- orderNumberstringDescription
- orderStartDatestring<date>DescriptionFormatdate
- paymentMethodstring<Electronic | NonElectronic | ACH | Bank Transfer | Cash | Check | Credit Card | Debit Card | Paypal | Wire Transfer | Other>DescriptionDefaultNoneAllowedElectronicNonElectronicACHBank TransferCashCheckCredit CardDebit CardPaypalWire TransferOther
- poDatestring<date>DescriptionFormatdate
- poNumberstringDescriptionMax Length80
- priceBookIdstringDescription
- shipToContactIdstringDescription
- shippingAddressstringDescription
- statusstring<Draft | Activated | Canceled>DescriptionDefaultDraftAllowedDraftActivatedCanceled
- subtotalnumberDescription
- systemDiscountnumberDescription
- systemDiscountAmountnumberDescription
- taxnumberDescription
- totalAmountnumberDescription
- totalPricenumberDescription
- orderProductsobject[]
- actualQuantitynumberDescription
- autoRenewbooleanDescription
- billCycleDaystring<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>DescriptionAllowed1st of Month2nd of Month3rd of Month4th of Month5th of Month6th of Month7th of Month8th of Month9th of Month10th of Month11th of Month12th of Month13th of Month14th of Month15th of Month16th of Month17th of Month18th of Month19th of Month20th of Month21st of Month22nd of Month23rd of Month24th of Month25th of Month26th of Month27th of Month28th of Month29th of Month30th of Month31st of Month
- billCycleStartMonthstring<01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12>DescriptionAllowed010203040506070809101112
- billingPeriodstring<Month | Quarter | Semi-Annual | Annual | SameAsSubscriptionTerm>DescriptionAllowedMonthQuarterSemi-AnnualAnnualSameAsSubscriptionTerm
- billingTimingstring<In Advance | In Arrears>DescriptionAllowedIn AdvanceIn Arrears
- cancellationDatestring<date>DescriptionFormatdate
- carvesEligiblebooleanDescription
- carvesLiabilitySegmentstringDescription
- carvesRevenueSegmentstringDescription
- contractLiabilitySegmentstringDescription
- contractRevenueSegmentstringDescription
- customerIdstringDescription
- defaultRenewalTermnumberDescription
- deltaACVnumberDescription
- deltaARRnumberDescription
- deltaCMRRnumberDescription
- deltaTCVnumberDescription
- descriptionstringDescription
- discountnumberDescription
- discountAmountnumberDescription
- entityIdstringDescription
- entityUseCodestring<A | B | C | D | E | F | G | H | I | J | K | L | M | N | P | Q | R | TAXABLE>DescriptionAllowedABCDEFGHIJKLMNPQRTAXABLE
- evergreenbooleanDescription
- idstringDescription
- lineTypestring<LineItem | RampItem | SummaryItem | ChangeItem | SplitItem>DescriptionAllowedLineItemRampItemSummaryItemChangeItemSplitItem
- listPricenumberDescription
- listTotalPricenumberDescription
- namestringDescription
- netSalesPricenumberDescription
- orderIdstringDescription
- parentOrderProductIdstringDescription
- priceBookEntryIdstringDescription
- productIdstringDescription
- productNamestringDescription
- quantitynumberDescription
- rootOrderProductIdstringDescription
- salesPricenumberDescription
- skustringDescription
- sortOrderintegerDescription
- statusstringDescription
- subscriptionEndDatestring<date>DescriptionFormatdate
- subscriptionStartDatestring<date>DescriptionFormatdate
- subscriptionTermnumberDescription
- subtotalnumberDescription
- systemDiscountnumberDescription
- systemDiscountAmountnumberDescription
- taxnumberDescription
- totalAmountnumberDescription
- totalPricenumberDescription
- uomstringDescription
- uomIdstringDescription
- previewInvoicesobject[]Description
- accountExstringDescription
- accountIdstringDescription
- accountingStatusstringDescription
- amountnumberDescription
- amountWithoutTaxnumberDescription
- balancenumberDescription
- dueDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- groupKeyobject
- BillingAccountstringDescription
- invoiceDatestring<date>DescriptionFormatdate
- itemsobject[]
- accountIdstringDescription
- groupKeyobject
- BillingAccountstringDescription
- recordTypestringDescription
- productIdstringDescription
- productNamestringDescription
- assetIdstringDescription
- assetNumberstringDescription
- assetTypestring<Subscription | Asset | Entitlement>DescriptionAllowedSubscriptionAssetEntitlement
- uomIdstringDescription
- transactionDatestring<date>DescriptionFormatdate
- transactionAmountnumberDescription
- transactionQuantitynumberDescription
- shippingAndHandlingnumberDescription
- taxAmountnumberDescription
- netSalesPricenumberDescription
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- billingTimingstring<In Advance | In Arrears>DescriptionAllowedIn AdvanceIn Arrears
- statusstringDescription
- taxStatusstringDescription
- paymentMethodsstring[]Description
- recordTypestringDescription
- shippingAndHandlingnumberDescription
- startDatestring<date>DescriptionFormatdate
- statusstring<Draft | Active | Canceled | PendingActivation | E-Invoicing>DescriptionAllowedDraftActiveCanceledPendingActivationE-Invoicing
- taxAmountnumberDescription
- taxStatusstringDescription
- subscriptionsobject[]Description
- warningsobject[]Description
- codestringDescription
- messagestringDescription
400
- object
- statusstring<FAILURE>DescriptionAllowedFAILURE
- errorTypestringDescription
- errorCodestringDescription
- messagestringDescription
curl
curl --request POST \
--url https://api.nue.io/orders \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"customer": {
"id": ""
},
"effectiveDate": "",
"orderProducts": [
{
"priceBookEntryId": "",
"quantity": "",
"subscriptionStartDate": "",
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
},
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
]
}
],
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
],
"options": {},
"billToContact": {
"id": ""
},
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"customer": {
"id": ""
},
"effectiveDate": "",
"orderProducts": [
{
"priceBookEntryId": "",
"quantity": "",
"subscriptionStartDate": "",
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
},
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
]
}
],
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
],
"options": {},
"billToContact": {
"id": ""
},
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.nue.io/orders", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/orders")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"customer": {
"id": ""
},
"effectiveDate": "",
"orderProducts": [
{
"priceBookEntryId": "",
"quantity": "",
"subscriptionStartDate": "",
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
},
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
]
}
],
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
],
"options": {},
"billToContact": {
"id": ""
},
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/orders"
payload = json.dumps({
"customer": {
"id": ""
},
"effectiveDate": "",
"orderProducts": [
{
"priceBookEntryId": "",
"quantity": "",
"subscriptionStartDate": "",
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
},
"addOns": [
{
"productOptionId": "",
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
]
}
],
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
}
],
"options": {},
"billToContact": {
"id": ""
},
"paymentMethodObject": {
"externalPaymentMethodId": "",
"name": "",
"paymentMethodType": "",
"paymentSystem": "",
"autoChargeEnabled": ""
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Order preview created successfully
{
"status": "",
"data": {
"assets": [
{}
],
"entitlements": [
{}
],
"order": {
"activatedById": "",
"activatedDate": "",
"billCycleDay": "",
"billToContactId": "",
"billingAccountId": "",
"billingAddress": "",
"billingPeriod": "",
"cancellationDate": "",
"customerId": "",
"description": "",
"discount": 0,
"discountAmount": 0,
"endDate": "",
"entityUseCode": "",
"id": "",
"isShippingAddressSameAsBilling": false,
"listTotal": 0,
"name": "",
"orderNumber": "",
"orderStartDate": "",
"paymentMethod": "",
"poDate": "",
"poNumber": "",
"priceBookId": "",
"shipToContactId": "",
"shippingAddress": "",
"status": "",
"subtotal": 0,
"systemDiscount": 0,
"systemDiscountAmount": 0,
"tax": 0,
"totalAmount": 0,
"totalPrice": 0
},
"orderProducts": [
{
"actualQuantity": 0,
"autoRenew": false,
"billCycleDay": "",
"billCycleStartMonth": "",
"billingPeriod": "",
"billingTiming": "",
"cancellationDate": "",
"carvesEligible": false,
"carvesLiabilitySegment": "",
"carvesRevenueSegment": "",
"contractLiabilitySegment": "",
"contractRevenueSegment": "",
"customerId": "",
"defaultRenewalTerm": 0,
"deltaACV": 0,
"deltaARR": 0,
"deltaCMRR": 0,
"deltaTCV": 0,
"description": "",
"discount": 0,
"discountAmount": 0,
"entityId": "",
"entityUseCode": "",
"evergreen": false,
"id": "",
"lineType": "",
"listPrice": 0,
"listTotalPrice": 0,
"name": "",
"netSalesPrice": 0,
"orderId": "",
"parentOrderProductId": "",
"priceBookEntryId": "",
"productId": "",
"productName": "",
"quantity": 0,
"rootOrderProductId": "",
"salesPrice": 0,
"sku": "",
"sortOrder": 0,
"status": "",
"subscriptionEndDate": "",
"subscriptionStartDate": "",
"subscriptionTerm": 0,
"subtotal": 0,
"systemDiscount": 0,
"systemDiscountAmount": 0,
"tax": 0,
"totalAmount": 0,
"totalPrice": 0,
"uom": "",
"uomId": ""
}
],
"previewInvoices": [
{
"accountEx": "",
"accountId": "",
"accountingStatus": "",
"amount": 0,
"amountWithoutTax": 0,
"balance": 0,
"dueDate": "",
"endDate": "",
"groupKey": {
"BillingAccount": ""
},
"invoiceDate": "",
"items": [
{
"accountId": "",
"groupKey": {
"BillingAccount": ""
},
"recordType": "",
"productId": "",
"productName": "",
"assetId": "",
"assetNumber": "",
"assetType": "",
"uomId": "",
"transactionDate": "",
"transactionAmount": 0,
"transactionQuantity": 0,
"shippingAndHandling": 0,
"taxAmount": 0,
"netSalesPrice": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"taxStatus": ""
}
],
"paymentMethods": [
""
],
"recordType": "",
"shippingAndHandling": 0,
"startDate": "",
"status": "",
"taxAmount": 0,
"taxStatus": ""
}
],
"subscriptions": [
{}
]
},
"warnings": [
{
"code": "",
"message": ""
}
]
}400
// Bad request due to invalid input parameters
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}GENERATED
// Bad request due to invalid input parameters
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}invalidAddonHierarchy
// Invalid Add-on Hierarchy
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "INVALID_ADDON_HIERARCHY",
"message": "Invalid add-on: Product option po-12345 is not available at this level in the product hierarchy"
}invalidAddonQuantity
// Invalid Add-on Quantity
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "INVALID_ADDON_QUANTITY",
"message": "Add-on quantity (3) is below minimum quantity (5) for option po-12345: Premium Feature"
}missingAddonQuantity
// Missing Add-on Quantity
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "MISSING_ADDON_QUANTITY",
"message": "Product option quantity must be specified for editable add-on po-12345: Premium Feature"
}invalidAddonStartDate
// Invalid Add-on Start Date
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "INVALID_ADDON_START_DATE",
"message": "Add-on option po-12345: Premium Feature start date (2026-01-01) cannot be after parent's end date (2025-12-31)"
}subscriptionTermNotAllowed
// Subscription Term Not Allowed
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "SUBSCRIPTION_TERM_NOT_ALLOWED",
"message": "Subscription term is not allowed for evergreen add-on product: Premium Feature"
}insufficientFeatureOptions
// Insufficient Feature Options
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "INSUFFICIENT_FEATURE_OPTIONS",
"message": "Product group Advanced Features requires at least 2 options, but only 1 were selected"
}excessiveFeatureOptions
// Excessive Feature Options
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "EXCESSIVE_FEATURE_OPTIONS",
"message": "Product group Basic Features allows a maximum of 3 options, but 4 were selected"
}missingRequiredAddons
// Missing Required Add-ons
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "MISSING_REQUIRED_ADDONS",
"message": "Missing required add-ons: Core Module, Authentication Module"
}duplicateProductOptions
// Duplicate Product Options
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "DUPLICATE_PRODUCT_OPTIONS",
"message": "Duplicate product options found: po-12345. Each product option can only be added once."
}