--- title: Update Subscription slug: update-subscription docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "1ozOEHwk0_wDlJabY8pfA", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api.nue.io/subscriptions/{subscriptionId}", "servers": [ { "url": "https://api.nue.io/subscriptions/{subscriptionId}", "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/subscriptions/{subscriptionId}", "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": "Update Subscription", "description": "This endpoint allows you to update specific fields of an existing subscription.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "subscriptionId", "type": "string", "description": "The unique identifier of the subscription to update." } ], "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": "autoRenew", "kind": "optional", "type": "boolean", "description": "" }, { "name": "Ruby__Custom_Field__c", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful update of the subscription.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "data", "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": "billingTiming", "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": "evergreen", "kind": "optional", "type": "boolean", "description": "" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "" }, { "name": "externalName", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "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": "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": "warnings", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "HdruhZdq0PB3WErCtrd-Y", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.nue.io/subscriptions/{subscriptionId} \\\n --header 'accept: application/json'" }, { "id": "PbpiV_tZ-8_1OJldCuQSJ", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/subscriptions/{subscriptionId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "pEBf_lZ6d5aOZe-PgyPJl", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/subscriptions/{subscriptionId}\")\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\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "tzx6DDm8bH815s5vKIJSq", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/subscriptions/{subscriptionId}\"\n\npayload = {}\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": "HdruhZdq0PB3WErCtrd-Y" }, "results": { "languages": [ { "id": "3tk4-MhGuvVwgQPcsxTJo", "language": "200", "code": "// Successful update of the subscription.\n{\n \"status\": \"\",\n \"data\": [\n {\n \"actualSubscriptionTerm\": 0,\n \"autoRenew\": false,\n \"billingTiming\": \"\",\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 \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\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 \"warnings\": [\n {}\n ]\n}" } ], "selectedLanguageId": "3tk4-MhGuvVwgQPcsxTJo" } }, "children": [ { "text": "" } ] }