--- title: Activate Draft Order slug: activate-draft-order docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "6jvUq7adyi-98CEiFgFJf", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/orders/{draftOrderId}", "servers": [ { "url": "https://api.nue.io/orders/{draftOrderId}", "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/{draftOrderId}", "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": "Activate Draft Order", "description": "

This endpoint demonstrates how to activate a preview order, turning the Draft order into an Active order. This is for both new orders and change orders.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "draftOrderId", "type": "string", "description": "The id of the preview draft order." } ], "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": "options", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "generateInvoice", "kind": "optional", "type": "boolean", "description": "" }, { "name": "activateInvoice", "kind": "optional", "type": "boolean", "description": "" }, { "name": "processPayment", "kind": "optional", "type": "boolean", "description": "

Enable synchronous payment confirmation. When true, the order is computed in memory, payment is charged via Stripe, then everything is committed atomically. Requires generateInvoice and activateInvoice to both be true. Negative invoices (e.g., from cancellations) automatically skip payment.

" }, { "name": "cancelOnPaymentFail", "kind": "optional", "type": "boolean", "description": "

Only valid when processPayment is true. If true, rolls back the entire activation on payment failure — nothing is committed and the order stays in Draft (HTTP 400). If false, commits the order and subscriptions despite the payment failure and returns HTTP 207 with a warning.

" } ] }, { "name": "poNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "poDate", "kind": "optional", "type": "string", "description": "", "format": "date" }, { "name": "transactionHub", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "externalSystem", "kind": "optional", "type": "string", "description": "" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "" }, { "name": "transactionType", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "orderProducts", "kind": "optional", "type": "array", "description": "

Optional array of order products to update with custom fields or revenueContractId before activation. Updates are applied before the activation event is committed, so downstream syncs (e.g., RightRev) receive the updated values. Each entry must include the order product id plus the fields to set.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "

UUID of the order product (from the draft order). Must belong to the order being activated.

" }, { "name": "revenueContractId", "kind": "optional", "type": "string", "description": "Revenue contract identifier used to group order products in RightRev." } ] }, { "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": [] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "assets", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "assetCompositeId", "kind": "optional", "type": "string", "description": "" }, { "name": "assetLevel", "kind": "optional", "type": "number", "description": "" }, { "name": "assetNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "assetProvidedById", "kind": "optional", "type": "string", "description": "" }, { "name": "assetServicedById", "kind": "optional", "type": "string", "description": "" }, { "name": "assetVersion", "kind": "optional", "type": "number", "description": "" }, { "name": "billCycleDay", "kind": "optional", "type": "string", "description": "" }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string", "description": "" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "" }, { "name": "contactId", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "entityId", "kind": "optional", "type": "string", "description": "" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "installDate", "kind": "optional", "type": "string", "description": "" }, { "name": "internalAsset", "kind": "optional", "type": "boolean", "description": "" }, { "name": "isCompetitorProduct", "kind": "optional", "type": "boolean", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "lastVersionedAssetId", "kind": "optional", "type": "string", "description": "" }, { "name": "lifecycleEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "lifecycleStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "locationId", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "" }, { "name": "originalAssetId", "kind": "optional", "type": "string", "description": "" }, { "name": "parentAssetObject", "kind": "optional", "type": "string", "description": "" }, { "name": "parentId", "kind": "optional", "type": "string", "description": "" }, { "name": "price", "kind": "optional", "type": "number", "description": "" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "" }, { "name": "productCode", "kind": "optional", "type": "string", "description": "" }, { "name": "productDescription", "kind": "optional", "type": "string", "description": "" }, { "name": "productFamily", "kind": "optional", "type": "string", "description": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "" }, { "name": "purchaseDate", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "" }, { "name": "reconfigureEffectiveDate", "kind": "optional", "type": "string", "description": "" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "statusReason", "kind": "optional", "type": "string", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "tcv", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAcv", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "totalTcv", "kind": "optional", "type": "number", "description": "" }, { "name": "uniqueIdentifier", "kind": "optional", "type": "string", "description": "" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "" }, { "name": "usageEndDate", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "" }, { "name": "entitlementCompositeId", "kind": "optional", "type": "string", "description": "" }, { "name": "entitlementLevel", "kind": "optional", "type": "number", "description": "" }, { "name": "entitlementNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "entitlementVersion", "kind": "optional", "type": "number", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "isDeleted", "kind": "optional", "type": "boolean", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "lastVersionedEntitlementId", "kind": "optional", "type": "string", "description": "" }, { "name": "lifecycleEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "lifecycleStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "orderNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "orderOnDate", "kind": "optional", "type": "string", "description": "" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "" }, { "name": "originalEntitlementId", "kind": "optional", "type": "string", "description": "" }, { "name": "originalEntitlementNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "parentEntitlementObject", "kind": "optional", "type": "string", "description": "" }, { "name": "parentId", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "" }, { "name": "productName", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "" }, { "name": "quantityDimension", "kind": "optional", "type": "string", "description": "" }, { "name": "reconfigureEffectiveDate", "kind": "optional", "type": "string", "description": "" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "tcv", "kind": "optional", "type": "number", "description": "" }, { "name": "termDimension", "kind": "optional", "type": "string", "description": "" }, { "name": "totalACV", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "totalTCV", "kind": "optional", "type": "number", "description": "" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "invoices", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "invoice", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "activatedById", "kind": "optional", "type": "string", "description": "" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "" }, { "name": "dueDate", "kind": "optional", "type": "string", "description": "" }, { "name": "source", "kind": "optional", "type": "string", "description": "" }, { "name": "taxStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "" }, { "name": "balance", "kind": "optional", "type": "number", "description": "" }, { "name": "vatMessages", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingMandateId", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingDocStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedByObject", "kind": "optional", "type": "string", "description": "" }, { "name": "targetDate", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "externalTaxId", "kind": "optional", "type": "string", "description": "" }, { "name": "currencyIsoCode", "kind": "optional", "type": "string", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "isCatchUp", "kind": "optional", "type": "boolean", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "syncTime", "kind": "optional", "type": "string", "description": "" }, { "name": "poNumbers", "kind": "optional", "type": "string", "description": "" }, { "name": "customFields", "kind": "optional", "type": "string", "description": "" }, { "name": "poDates", "kind": "optional", "type": "string", "description": "" }, { "name": "taxErrorMessage", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "paymentDetails", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingMessage", "kind": "optional", "type": "string", "description": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "" }, { "name": "amountWithoutTax", "kind": "optional", "type": "number", "description": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "" }, { "name": "comments", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "recordType", "kind": "optional", "type": "string", "description": "" }, { "name": "entityId", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingMandateCode", "kind": "optional", "type": "string", "description": "" }, { "name": "invoiceDate", "kind": "optional", "type": "string", "description": "" }, { "name": "accountingStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "paymentHostedUrl", "kind": "optional", "type": "string", "description": "" }, { "name": "invoicePdf", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "" }, { "name": "activatedTime", "kind": "optional", "type": "string", "description": "" }, { "name": "tenantId", "kind": "optional", "type": "string", "description": "" }, { "name": "externalInvoiceId", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingDocId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "transactionQuantity", "kind": "optional", "type": "number", "description": "" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "" }, { "name": "customFields", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "productName", "kind": "optional", "type": "string", "description": "" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "" }, { "name": "transactionAmountWithoutTax", "kind": "optional", "type": "number", "description": "" }, { "name": "assetNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "balance", "kind": "optional", "type": "number", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedByItemId", "kind": "optional", "type": "string", "description": "" }, { "name": "transactionAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "invoiceNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "taxPercent", "kind": "optional", "type": "number", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedByObject", "kind": "optional", "type": "string", "description": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "recordType", "kind": "optional", "type": "string", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "entityId", "kind": "optional", "type": "string", "description": "" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "" }, { "name": "transactionDate", "kind": "optional", "type": "string", "description": "" }, { "name": "assetType", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedCredits", "kind": "optional", "type": "number", "description": "" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "" }, { "name": "tenantId", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "invoiceId", "kind": "optional", "type": "string", "description": "" }, { "name": "currencyIsoCode", "kind": "optional", "type": "string", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "isCatchUp", "kind": "optional", "type": "boolean", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "" }, { "name": "ratedCredits", "kind": "optional", "type": "number", "description": "" } ] } ] }, { "name": "order", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "activatedById", "kind": "optional", "type": "string", "description": "" }, { "name": "activatedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "" }, { "name": "billingAddress", "kind": "optional", "type": "string", "description": "" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "" }, { "name": "cancelOnPaymentFail", "kind": "optional", "type": "boolean", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "isShippingAddressSameAsBilling", "kind": "optional", "type": "boolean", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "listTotal", "kind": "optional", "type": "number", "description": "" }, { "name": "orderACV", "kind": "optional", "type": "number", "description": "" }, { "name": "orderNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "orderPlacedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "orderStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "orderTCV", "kind": "optional", "type": "number", "description": "" }, { "name": "ownerId", "kind": "optional", "type": "string", "description": "" }, { "name": "platformOrigin", "kind": "optional", "type": "string", "description": "" }, { "name": "poDate", "kind": "optional", "type": "string", "description": "" }, { "name": "poNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "orderProducts", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "description": "" }, { "name": "actualQuantity", "kind": "optional", "type": "number", "description": "" }, { "name": "actualSubscriptionTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "" }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "carvesEligible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "deltaACV", "kind": "optional", "type": "number", "description": "" }, { "name": "deltaARR", "kind": "optional", "type": "number", "description": "" }, { "name": "deltaCMRR", "kind": "optional", "type": "number", "description": "" }, { "name": "deltaTCV", "kind": "optional", "type": "number", "description": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "evergreen", "kind": "optional", "type": "boolean", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "lineType", "kind": "optional", "type": "string", "description": "" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "listTotalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "orderId", "kind": "optional", "type": "string", "description": "" }, { "name": "parentOrderProductId", "kind": "optional", "type": "string", "description": "" }, { "name": "poDate", "kind": "optional", "type": "string", "description": "" }, { "name": "poNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "" }, { "name": "productName", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "" }, { "name": "rootOrderProductId", "kind": "optional", "type": "string", "description": "" }, { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "sortOrder", "kind": "optional", "type": "number", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "tax", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "subscriptions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "actualSubscriptionTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "evergreen", "kind": "optional", "type": "boolean", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "orderOnDate", "kind": "optional", "type": "string", "description": "" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "" }, { "name": "parentId", "kind": "optional", "type": "string", "description": "" }, { "name": "parentObjectType", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "" }, { "name": "renewalTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionCompositeId", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionLevel", "kind": "optional", "type": "number", "description": "" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "subscriptionVersion", "kind": "optional", "type": "number", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "tcv", "kind": "optional", "type": "number", "description": "" }, { "name": "totalACV", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "totalTCV", "kind": "optional", "type": "number", "description": "" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "transactionHub", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "transactionType", "kind": "optional", "type": "string", "description": "" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "" }, { "name": "externalSystem", "kind": "optional", "type": "string", "description": "" } ] } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ] }, { "statusCode": "207", "description": "

Multi-Status — order activated but payment failed. Returned when processPayment is true, cancelOnPaymentFail is false, and payment processing fails. The order and subscriptions are committed; payment must be retried separately.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "", "example": "PARTIAL_SUCCESS" }, { "name": "errorType", "kind": "optional", "type": "string", "description": "", "example": "PAYMENT_PROCESSING_FAILED" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "", "example": "PAYMENT_FAILED" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "order", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [ { "name": "billToContactId", "kind": "optional", "type": "string", "description": "ID of the contact to bill" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "ID of the customer placing the order" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Amount of discount applied to the order" }, { "name": "discountPercentage", "kind": "optional", "type": "number", "description": "Percentage of discount applied to the order" }, { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "Effective date of the order" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the order" }, { "name": "listTotal", "kind": "optional", "type": "number", "description": "Total list price of the order" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "ID of the price book used for the order" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the order" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "Subtotal amount of the order" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "System discount applied to the order" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "Amount of system discount applied" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total amount of the order" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Total price of the order" } ] }, { "name": "subscriptions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "actualSubscriptionTerm", "kind": "optional", "type": "number", "description": "Actual term of the subscription" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "

Indicates if the subscription auto-renews

" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Timing of billing for the subscription" }, { "name": "bundled", "kind": "optional", "type": "boolean", "description": "Indicates if the subscription is bundled" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "ID of the user who created the subscription" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "Date and time when the subscription was created", "format": "date-time" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "ID of the customer associated with the subscription" }, { "name": "evergreen", "kind": "optional", "type": "boolean", "description": "Indicates if the subscription is evergreen" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "

Mapping to an identifier from an external system, in this case Salesforce

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

Mapping to the name from an external system, in this case Salesforce

" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the subscription" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "ID of the user who last modified the subscription" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "Date and time when the subscription was last modified", "format": "date-time" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "List price of the subscription" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the subscription" }, { "name": "nextBillingDate", "kind": "optional", "type": "string", "description": "Next billing date of the subscription" }, { "name": "orderOnDate", "kind": "optional", "type": "string", "description": "Date when the subscription was ordered" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "ID of the order product associated with the subscription" }, { "name": "parentSubscriptionObject", "kind": "optional", "type": "string", "description": "Object type of the parent subscription" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "ID of the price book entry for the subscription" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "ID of the price book for the subscription" }, { "name": "product", "kind": "optional", "type": "map", "description": "Product object.", "example": "", "customType": "map", "schema": [] }, { "name": "productId", "kind": "optional", "type": "string", "description": "ID of the product associated with the subscription" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Quantity of the subscription" }, { "name": "renewalTerm", "kind": "optional", "type": "number", "description": "Term for renewal of the subscription" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "ID of the root subscription" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "Sales price of the subscription" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the subscription" }, { "name": "subscriptionCompositeId", "kind": "optional", "type": "string", "description": "Composite ID of the subscription" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "End date of the subscription" }, { "name": "subscriptionLevel", "kind": "optional", "type": "number", "description": "Level of the subscription in the hierarchy" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "Start date of the subscription" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Term of the subscription" }, { "name": "subscriptionVersion", "kind": "optional", "type": "number", "description": "Version of the subscription" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "Tax amount for the subscription" }, { "name": "tcv", "kind": "optional", "type": "number", "description": "Total Contract Value of the subscription" }, { "name": "totalACV", "kind": "optional", "type": "number", "description": "Total Annual Contract Value of the subscription" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total amount for the subscription" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Total price of the subscription" }, { "name": "totalTCV", "kind": "optional", "type": "number", "description": "Total Total Contract Value of the subscription" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "ID of the Unit of Measure for the subscription" } ] }, { "name": "invoices", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "invoice", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [ { "name": "accountingStatus", "kind": "optional", "type": "string", "description": "The current accounting status of the invoice" }, { "name": "activatedById", "kind": "optional", "type": "string", "description": "The ID of the user who activated the invoice" }, { "name": "activatedTime", "kind": "optional", "type": "string", "description": "The timestamp when the invoice was activated", "format": "date-time" }, { "name": "amount", "kind": "optional", "type": "number", "description": "The total amount of the invoice including tax" }, { "name": "amountWithoutTax", "kind": "optional", "type": "number", "description": "The total amount of the invoice excluding tax" }, { "name": "balance", "kind": "optional", "type": "number", "description": "The remaining balance on the invoice" }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "The ID of the contact to bill" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "The unique identifier of the customer" }, { "name": "dueDate", "kind": "optional", "type": "string", "description": "The due date for payment of the invoice" }, { "name": "id", "kind": "optional", "type": "string", "description": "The unique identifier of the invoice" }, { "name": "invoiceDate", "kind": "optional", "type": "string", "description": "The date the invoice was issued" }, { "name": "invoicePdf", "kind": "optional", "type": "string", "description": "The URI of the invoice PDF", "format": "uri" }, { "name": "isCatchUp", "kind": "optional", "type": "boolean", "description": "

Indicates if this is a catch-up invoice

" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name or number of the invoice" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "The current payment status of the invoice" }, { "name": "recordType", "kind": "optional", "type": "string", "description": "

The type of record (e.g., invoice, credit memo)

" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "The ID of the sales account" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "The total shipping and handling charges" }, { "name": "source", "kind": "optional", "type": "string", "description": "The source of the invoice" }, { "name": "status", "kind": "optional", "type": "string", "description": "The current status of the invoice" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "The total tax amount on the invoice" }, { "name": "taxStatus", "kind": "optional", "type": "string", "description": "The tax status of the invoice" }, { "name": "tenantId", "kind": "optional", "type": "string", "description": "The ID of the tenant" } ] }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "accountId", "kind": "optional", "type": "string", "description": "The unique identifier of the account" }, { "name": "appliedCredits", "kind": "optional", "type": "number", "description": "The amount of credits applied to the invoice" }, { "name": "assetNumber", "kind": "optional", "type": "string", "description": "The asset number associated with this item" }, { "name": "assetType", "kind": "optional", "type": "string", "description": "The type of asset" }, { "name": "balance", "kind": "optional", "type": "number", "description": "The balance of the asset" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "

The timing of billing for this product (e.g., in advance, in arrears)

" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "The ID of the user who created this item" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "The date and time when the item was created", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "The end date of the billing period" }, { "name": "id", "kind": "optional", "type": "string", "description": "The unique identifier of the item" }, { "name": "invoiceId", "kind": "optional", "type": "string", "description": "The unique identifier of the invoice" }, { "name": "invoiceNumber", "kind": "optional", "type": "string", "description": "The name or number of the invoice" }, { "name": "isCatchUp", "kind": "optional", "type": "boolean", "description": "

Indicates if this is a catch-up invoice

" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "The ID of the user who last modified this item" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "The date and time when the item was last modified", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name or number of the item" }, { "name": "productId", "kind": "optional", "type": "string", "description": "The unique identifier of the product" }, { "name": "productName", "kind": "optional", "type": "string", "description": "The name of the product or service" }, { "name": "ratedCredits", "kind": "optional", "type": "number", "description": "The rated credits for this item" }, { "name": "recordType", "kind": "optional", "type": "string", "description": "

The type of record (e.g., invoice, credit memo)

" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "The ID of the sales account" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "The total shipping and handling charges" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "The start date of the billing period" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "The tax amount for this item" }, { "name": "tenantId", "kind": "optional", "type": "string", "description": "The ID of the tenant" }, { "name": "transactionAmount", "kind": "optional", "type": "number", "description": "The total transaction amount for this item" }, { "name": "transactionAmountWithoutTax", "kind": "optional", "type": "number", "description": "The total transaction amount without tax for this item" }, { "name": "transactionDate", "kind": "optional", "type": "string", "description": "The date of the transaction" }, { "name": "transactionQuantity", "kind": "optional", "type": "number", "description": "The quantity of the item in this transaction" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "The unique identifier of the Unit of Measure" } ] } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "n43bK4o-l8eLUffpwJiik", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/orders/{draftOrderId} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"options\": {},\n \"orderProducts\": [\n {\n \"id\": \"\"\n }\n ],\n \"paymentMethodObject\": {\n \"externalPaymentMethodId\": \"\",\n \"name\": \"\",\n \"paymentMethodType\": \"\",\n \"paymentSystem\": \"\",\n \"autoChargeEnabled\": \"\"\n }\n }'" }, { "id": "qxdQJEX1FuemTdYOF8Z0A", "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 \"options\": {},\n \"orderProducts\": [\n {\n \"id\": \"\"\n }\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/{draftOrderId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "_Wo9BaekiKpFbqigT02yY", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/orders/{draftOrderId}\")\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 \"options\": {},\n \"orderProducts\": [\n {\n \"id\": \"\"\n }\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": "2k9tFp3F0-gfFepDXf3hp", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/orders/{draftOrderId}\"\n\npayload = json.dumps({\n \"options\": {},\n \"orderProducts\": [\n {\n \"id\": \"\"\n }\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": "n43bK4o-l8eLUffpwJiik" }, "results": { "languages": [ { "id": "9DH445ERwbRXJvA6PNY6H", "language": "201", "code": "// Created\n{\n \"status\": \"\",\n \"data\": {\n \"assets\": [\n {\n \"assetCompositeId\": \"\",\n \"assetLevel\": 0,\n \"assetNumber\": \"\",\n \"assetProvidedById\": \"\",\n \"assetServicedById\": \"\",\n \"assetVersion\": 0,\n \"billCycleDay\": \"\",\n \"billCycleStartMonth\": \"\",\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"contactId\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"description\": \"\",\n \"entityId\": \"\",\n \"externalId\": \"\",\n \"id\": \"\",\n \"installDate\": \"\",\n \"internalAsset\": false,\n \"isCompetitorProduct\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedAssetId\": \"\",\n \"lifecycleEndDate\": \"\",\n \"lifecycleStartDate\": \"\",\n \"listPrice\": 0,\n \"locationId\": \"\",\n \"name\": \"\",\n \"orderProductId\": \"\",\n \"originalAssetId\": \"\",\n \"parentAssetObject\": \"\",\n \"parentId\": \"\",\n \"price\": 0,\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"productCode\": \"\",\n \"productDescription\": \"\",\n \"productFamily\": \"\",\n \"productId\": \"\",\n \"purchaseDate\": \"\",\n \"quantity\": 0,\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"serialNumber\": \"\",\n \"sku\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"statusReason\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"totalAcv\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTcv\": 0,\n \"uniqueIdentifier\": \"\",\n \"uomId\": \"\",\n \"usageEndDate\": \"\"\n }\n ],\n \"entitlements\": [\n {\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"endDate\": \"\",\n \"entitlementCompositeId\": \"\",\n \"entitlementLevel\": 0,\n \"entitlementNumber\": \"\",\n \"entitlementVersion\": 0,\n \"id\": \"\",\n \"isDeleted\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedEntitlementId\": \"\",\n \"lifecycleEndDate\": \"\",\n \"lifecycleStartDate\": \"\",\n \"listPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderNumber\": \"\",\n \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\n \"originalEntitlementId\": \"\",\n \"originalEntitlementNumber\": \"\",\n \"parentEntitlementObject\": \"\",\n \"parentId\": \"\",\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"quantity\": 0,\n \"quantityDimension\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"startDate\": \"\",\n \"status\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"termDimension\": \"\",\n \"totalACV\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTCV\": 0,\n \"uomId\": \"\"\n }\n ],\n \"invoices\": [\n {\n \"invoice\": {\n \"activatedById\": \"\",\n \"salesAccountId\": \"\",\n \"endDate\": \"\",\n \"dueDate\": \"\",\n \"source\": \"\",\n \"taxStatus\": \"\",\n \"shippingAndHandling\": 0,\n \"balance\": 0,\n \"vatMessages\": \"\",\n \"id\": \"\",\n \"billToContactId\": \"\",\n \"einvoicingMandateId\": \"\",\n \"createdById\": \"\",\n \"einvoicingDocStatus\": \"\",\n \"appliedByObject\": \"\",\n \"targetDate\": \"\",\n \"name\": \"\",\n \"externalTaxId\": \"\",\n \"currencyIsoCode\": \"\",\n \"taxAmount\": 0,\n \"isCatchUp\": false,\n \"startDate\": \"\",\n \"status\": \"\",\n \"syncTime\": \"\",\n \"poNumbers\": \"\",\n \"customFields\": \"\",\n \"poDates\": \"\",\n \"taxErrorMessage\": \"\",\n \"appliedById\": \"\",\n \"lastModifiedById\": \"\",\n \"customerId\": \"\",\n \"paymentDetails\": \"\",\n \"einvoicingMessage\": \"\",\n \"paymentStatus\": \"\",\n \"cancellationDate\": \"\",\n \"amountWithoutTax\": 0,\n \"amount\": 0,\n \"comments\": \"\",\n \"lastModifiedDate\": \"\",\n \"recordType\": \"\",\n \"entityId\": \"\",\n \"einvoicingMandateCode\": \"\",\n \"invoiceDate\": \"\",\n \"accountingStatus\": \"\",\n \"paymentHostedUrl\": \"\",\n \"invoicePdf\": \"\",\n \"createdDate\": \"\",\n \"activatedTime\": \"\",\n \"tenantId\": \"\",\n \"externalInvoiceId\": \"\",\n \"einvoicingDocId\": \"\"\n },\n \"items\": [\n {\n \"transactionQuantity\": 0,\n \"salesAccountId\": \"\",\n \"endDate\": \"\",\n \"customFields\": \"\",\n \"description\": \"\",\n \"productName\": \"\",\n \"shippingAndHandling\": 0,\n \"transactionAmountWithoutTax\": 0,\n \"assetNumber\": \"\",\n \"balance\": 0,\n \"lastModifiedById\": \"\",\n \"appliedByItemId\": \"\",\n \"transactionAmount\": 0,\n \"invoiceNumber\": \"\",\n \"taxPercent\": 0,\n \"id\": \"\",\n \"createdById\": \"\",\n \"appliedByObject\": \"\",\n \"productId\": \"\",\n \"lastModifiedDate\": \"\",\n \"recordType\": \"\",\n \"billingTiming\": \"\",\n \"entityId\": \"\",\n \"uomId\": \"\",\n \"transactionDate\": \"\",\n \"assetType\": \"\",\n \"appliedCredits\": 0,\n \"accountId\": \"\",\n \"createdDate\": \"\",\n \"tenantId\": \"\",\n \"name\": \"\",\n \"invoiceId\": \"\",\n \"currencyIsoCode\": \"\",\n \"taxAmount\": 0,\n \"isCatchUp\": false,\n \"startDate\": \"\",\n \"ratedCredits\": 0\n }\n ]\n }\n ],\n \"order\": {\n \"activatedById\": \"\",\n \"activatedDate\": \"\",\n \"billingAccountId\": \"\",\n \"billingAddress\": \"\",\n \"billingPeriod\": \"\",\n \"cancelOnPaymentFail\": false,\n \"createdById\": \"\",\n \"customerId\": \"\",\n \"discount\": 0,\n \"discountAmount\": 0,\n \"id\": \"\",\n \"isShippingAddressSameAsBilling\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"listTotal\": 0,\n \"orderACV\": 0,\n \"orderNumber\": \"\",\n \"orderPlacedDate\": \"\",\n \"orderStartDate\": \"\",\n \"orderTCV\": 0,\n \"ownerId\": \"\",\n \"platformOrigin\": \"\",\n \"poDate\": \"\",\n \"poNumber\": \"\",\n \"priceBookId\": \"\",\n \"status\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0\n },\n \"orderProducts\": [\n {\n \"accountId\": \"\",\n \"actualQuantity\": 0,\n \"actualSubscriptionTerm\": 0,\n \"autoRenew\": false,\n \"billingAccountId\": \"\",\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"carvesEligible\": false,\n \"createdById\": \"\",\n \"deltaACV\": 0,\n \"deltaARR\": 0,\n \"deltaCMRR\": 0,\n \"deltaTCV\": 0,\n \"discount\": 0,\n \"discountAmount\": 0,\n \"evergreen\": false,\n \"id\": \"\",\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lineType\": \"\",\n \"listPrice\": 0,\n \"listTotalPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderId\": \"\",\n \"parentOrderProductId\": \"\",\n \"poDate\": \"\",\n \"poNumber\": \"\",\n \"priceBookEntryId\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"quantity\": 0,\n \"rootOrderProductId\": \"\",\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 \"uomId\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"actualSubscriptionTerm\": 0,\n \"autoRenew\": false,\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"createdById\": \"\",\n \"customerId\": \"\",\n \"evergreen\": false,\n \"id\": \"\",\n \"lastModifiedById\": \"\",\n \"listPrice\": 0,\n \"name\": \"\",\n \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\n \"parentId\": \"\",\n \"parentObjectType\": \"\",\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"productId\": \"\",\n \"quantity\": 0,\n \"renewalTerm\": 0,\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"status\": \"\",\n \"subscriptionCompositeId\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionLevel\": 0,\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subscriptionVersion\": 0,\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"totalACV\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTCV\": 0,\n \"uomId\": \"\"\n }\n ],\n \"transactionHub\": {\n \"transactionType\": \"\",\n \"externalId\": \"\",\n \"externalSystem\": \"\"\n }\n },\n \"warnings\": [\n \"\"\n ]\n}" }, { "id": "_UUGUGvK227c_3z3Ux8dW", "language": "207", "code": "// Multi-Status — order activated but payment failed. Returned when processPayment is true, cancelOnPaymentFail is false, and payment processing fails. The order and subscriptions are committed; payment must be retried separately.\n{\n \"status\": \"PARTIAL_SUCCESS\",\n \"errorType\": \"PAYMENT_PROCESSING_FAILED\",\n \"errorCode\": \"PAYMENT_FAILED\",\n \"message\": \"\",\n \"data\": {\n \"order\": \"\",\n \"subscriptions\": [\n {\n \"actualSubscriptionTerm\": 0,\n \"autoRenew\": false,\n \"billingTiming\": \"\",\n \"bundled\": false,\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"evergreen\": false,\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"listPrice\": 0,\n \"name\": \"\",\n \"nextBillingDate\": \"\",\n \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\n \"parentSubscriptionObject\": \"\",\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"quantity\": 0,\n \"renewalTerm\": 0,\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"status\": \"\",\n \"subscriptionCompositeId\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionLevel\": 0,\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subscriptionVersion\": 0,\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"totalACV\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTCV\": 0,\n \"uomId\": \"\"\n }\n ],\n \"invoices\": [\n {\n \"invoice\": \"\",\n \"items\": [\n {\n \"accountId\": \"\",\n \"appliedCredits\": 0,\n \"assetNumber\": \"\",\n \"assetType\": \"\",\n \"balance\": 0,\n \"billingTiming\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"endDate\": \"\",\n \"id\": \"\",\n \"invoiceId\": \"\",\n \"invoiceNumber\": \"\",\n \"isCatchUp\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"ratedCredits\": 0,\n \"recordType\": \"\",\n \"salesAccountId\": \"\",\n \"shippingAndHandling\": 0,\n \"startDate\": \"\",\n \"taxAmount\": 0,\n \"tenantId\": \"\",\n \"transactionAmount\": 0,\n \"transactionAmountWithoutTax\": 0,\n \"transactionDate\": \"\",\n \"transactionQuantity\": 0,\n \"uomId\": \"\"\n }\n ]\n }\n ]\n }\n}" } ], "selectedLanguageId": "9DH445ERwbRXJvA6PNY6H" } }, "children": [ { "text": "" } ] }