--- title: Patch Order Products slug: patch-order-products docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "Nxmwn6oDrUCPyVcnLMQ0N", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api.nue.io/orders/order-products", "servers": [ { "url": "https://api.nue.io/orders/order-products", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/orders/order-products", "description": "Nue Sandbox API Endpoint" } ], "name": "Patch Order Products", "description": "Update a list of order products.", "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": "array", "description": "Order products patch request", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "ID of the order product", "example": "802KS000000USFiYAO" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "Billing period for the product", "example": "Month" }, { "name": "billCycleDay", "kind": "optional", "type": "string", "description": "Billing cycle day", "example": "1st of Month" }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string", "description": "Billing cycle start month", "example": "01" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Billing timing", "example": "In Advance" }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "ID of the billing account associated with the subscription", "example": "a2x8G000000H4nk2AB" }, { "name": "defaultPaymentMethodId", "kind": "optional", "type": "string", "description": "ID of the default payment method for the subscription", "example": "pm_1Jm8a2KZvKYlo2CgX5X5X5X5" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "Whether the subscription should automatically renew", "example": true }, { "name": "entityId", "kind": "optional", "type": "string", "description": "Entity ID associated with the order product", "example": "a0FKS000000H4nk2AC" }, { "name": "paymentTerm", "kind": "optional", "type": "string", "description": "Payment term for the subscription", "example": "Net 30" }, { "name": "todaysProductId", "kind": "optional", "type": "string", "description": "Current product ID for the subscription", "example": "01t8G000000H4nk2AB" }, { "name": "todaysSku", "kind": "optional", "type": "string", "description": "Current SKU for the subscription", "example": "SKU-12345" }, { "name": "todaysProductName", "kind": "optional", "type": "string", "description": "Current product name for the subscription", "example": "Premium Plan" }, { "name": "todaysUom", "kind": "optional", "type": "string", "description": "Current unit of measure for the subscription", "example": "Each" }, { "name": "todaysQuantity", "kind": "optional", "type": "number", "description": "Current quantity for the subscription", "example": 1 }, { "name": "customField", "kind": "optional", "type": "string", "description": "Custom field for the subscription" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the order product" }, { "name": "carvesLiabilitySegment", "kind": "optional", "type": "string", "description": "Carves liability segment information" }, { "name": "carvesRevenueSegment", "kind": "optional", "type": "string", "description": "Carves revenue segment information" }, { "name": "carvesEligible", "kind": "optional", "type": "boolean", "description": "Whether the order product is eligible for carves", "example": false }, { "name": "contractRevenueSegment", "kind": "optional", "type": "string", "description": "Contract revenue segment information" }, { "name": "contractLiabilitySegment", "kind": "optional", "type": "string", "description": "Contract liability segment information" } ], "itemType": "object", "customType": "object[]", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Default Response", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Default Response\n{\n \"status\": \"\",\n \"failures\": [\n {\n \"entity\": {},\n \"error\": \"\"\n }\n ],\n \"recordsToUpdate\": \"\",\n \"recordsUpdated\": \"\"\n}" }, { "label": "Update Order Products Response", "code": "{\n \"status\": \"SUCCESS\",\n \"failures\": null,\n \"recordsToUpdate\": 1,\n \"recordsUpdated\": 1\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "UpdateBillingModelResponse", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "FAILURE", "SUCCESS", "PARTIAL_SUCCESS" ] }, { "name": "failures", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Failure", "customType": "Failure[]", "schema": [ { "name": "entity", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "error", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "recordsToUpdate", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "recordsUpdated", "kind": "optional", "type": "integer", "description": "", "format": "int32" } ], "modelRef": "#/components/schemas/UpdateBillingModelResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "S1MB26bKqKSRxLBzMwO9n", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.nue.io/orders/order-products \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '[\n {\n \"id\": \"802KS000000USFiYAO\"\n }\n ]'" }, { "id": "EOvd73kGrsE2O_HJHkcIt", "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 {\n \"id\": \"802KS000000USFiYAO\"\n }\n]);\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/orders/order-products\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "fPvpyx0auJpB2l7w-tV5B", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/orders/order-products\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump([\n {\n \"id\": \"802KS000000USFiYAO\"\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "fP3rvKl58SpCNdZ9YuqC0", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/orders/order-products\"\n\npayload = json.dumps([\n {\n \"id\": \"802KS000000USFiYAO\"\n }\n])\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "S1MB26bKqKSRxLBzMwO9n" }, "results": { "languages": [ { "id": "hpDLoIll0jWAcKqnRyiQn", "language": "200", "code": "// Default Response\n{\n \"status\": \"\",\n \"failures\": [\n {\n \"entity\": {},\n \"error\": \"\"\n }\n ],\n \"recordsToUpdate\": \"\",\n \"recordsUpdated\": \"\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// Default Response\n{\n \"status\": \"\",\n \"failures\": [\n {\n \"entity\": {},\n \"error\": \"\"\n }\n ],\n \"recordsToUpdate\": \"\",\n \"recordsUpdated\": \"\"\n}" }, { "label": "Update Order Products Response", "code": "{\n \"status\": \"SUCCESS\",\n \"failures\": null,\n \"recordsToUpdate\": 1,\n \"recordsUpdated\": 1\n}" } ] } ], "selectedLanguageId": "hpDLoIll0jWAcKqnRyiQn" } }, "children": [ { "text": "" } ] }