--- title: Rate Usage In Bulk slug: rate-usage-in-bulk docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "81U4-gP9dTHOgXV-mfn2w", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/orders/usage-rate", "servers": [ { "url": "https://api.nue.io/orders/usage-rate", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/orders/usage-rate", "description": "Nue Sandbox API Endpoint" } ], "name": "Rate Usage In Bulk", "description": "Rate usage in bulk", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "*/*" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Price rate based on customer's usage.", "customType": "UsageRateBulkRequest", "schema": [ { "name": "usages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/UsageRateRequest", "customType": "UsageRateRequest[]", "schema": [ { "name": "referenceId", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "consumedQuantity", "kind": "optional", "type": "number", "description": "" }, { "name": "deltaQuantity", "kind": "optional", "type": "number", "description": "" }, { "name": "ratingDate", "kind": "optional", "type": "string", "description": "" } ] } ], "modelRef": "#/components/schemas/UsageRateBulkRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successfully rated customer usage records", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Successfully rated customer usage records\n{\n \"error\": \"\",\n \"results\": [\n {\n \"referenceId\": \"\",\n \"subscriptionNumber\": \"\",\n \"lineItemId\": \"\",\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"subtotal\": 0,\n \"listTotal\": 0,\n \"quantity\": 0,\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"netSalesPrice\": 0,\n \"salesPrice\": 0,\n \"ratedCredit\": 0,\n \"success\": false,\n \"error\": \"\",\n \"orderItemId\": \"\",\n \"orderItemNumber\": \"\",\n \"orderNumber\": \"\",\n \"orderItemExternalId\": \"\",\n \"orderItemExternalName\": \"\",\n \"orderExternalName\": \"\"\n }\n ]\n}" }, { "label": "Successful Usage Rating Response", "code": "{\n \"error\": null,\n \"results\": [\n {\n \"referenceId\": \"e3c9e8eb-db44-4bce-898c-0f667163fd43\",\n \"subscriptionNumber\": \"SUB-00059394\",\n \"lineItemId\": \"d5294074-89fe-42f6-9a25-0fd5413cad17\",\n \"quantity\": 10,\n \"ratedCredit\": 20,\n \"success\": true\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "UsageRateBulkResponse", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "" }, { "name": "results", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/UsageRateResponse", "customType": "UsageRateResponse[]", "schema": [ { "name": "referenceId", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "lineItemId", "kind": "optional", "type": "string", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "" }, { "name": "listTotal", "kind": "optional", "type": "number", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "discountPercentage", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "ratedCredit", "kind": "optional", "type": "number", "description": "" }, { "name": "success", "kind": "optional", "type": "boolean", "description": "" }, { "name": "error", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "orderNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemExternalId", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemExternalName", "kind": "optional", "type": "string", "description": "" }, { "name": "orderExternalName", "kind": "optional", "type": "string", "description": "" } ] } ], "modelRef": "#/components/schemas/UsageRateBulkResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "default response", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// default response\n{\n \"error\": \"\",\n \"results\": [\n {\n \"referenceId\": \"\",\n \"subscriptionNumber\": \"\",\n \"lineItemId\": \"\",\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"subtotal\": 0,\n \"listTotal\": 0,\n \"quantity\": 0,\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"netSalesPrice\": 0,\n \"salesPrice\": 0,\n \"ratedCredit\": 0,\n \"success\": false,\n \"error\": \"\",\n \"orderItemId\": \"\",\n \"orderItemNumber\": \"\",\n \"orderNumber\": \"\",\n \"orderItemExternalId\": \"\",\n \"orderItemExternalName\": \"\",\n \"orderExternalName\": \"\"\n }\n ]\n}" }, { "label": "Price rate based on customer's usage.", "code": "{\n \"error\": null,\n \"results\": [\n {\n \"referenceId\": \"e3c9e8eb-db44-4bce-898c-0f667163fd43\",\n \"subscriptionNumber\": \"SUB-00059394\",\n \"lineItemId\": \"d5294074-89fe-42f6-9a25-0fd5413cad17\",\n \"quantity\": 10,\n \"ratedCredit\": 20,\n \"success\": true\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "UsageRateBulkResponse", "schema": [ { "name": "error", "kind": "optional", "type": "string", "description": "" }, { "name": "results", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/UsageRateResponse", "customType": "UsageRateResponse[]", "schema": [ { "name": "referenceId", "kind": "optional", "type": "string", "description": "" }, { "name": "subscriptionNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "lineItemId", "kind": "optional", "type": "string", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "" }, { "name": "listTotal", "kind": "optional", "type": "number", "description": "" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "discountPercentage", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "ratedCredit", "kind": "optional", "type": "number", "description": "" }, { "name": "success", "kind": "optional", "type": "boolean", "description": "" }, { "name": "error", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemId", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "orderNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemExternalId", "kind": "optional", "type": "string", "description": "" }, { "name": "orderItemExternalName", "kind": "optional", "type": "string", "description": "" }, { "name": "orderExternalName", "kind": "optional", "type": "string", "description": "" } ] } ], "modelRef": "#/components/schemas/UsageRateBulkResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "kTfnsgqie3KdOun62RWjI", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/orders/usage-rate \\\n --header 'accept: application/json'" }, { "id": "seh3V_sdSjq0BLZdObHSZ", "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: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/orders/usage-rate\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "VeZ7oeYe-FSI0XMqnRwsC", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/orders/usage-rate\")\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\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "k7fVFveQ_i4h2Kmsvu3c6", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/orders/usage-rate\"\n\npayload = {}\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": "kTfnsgqie3KdOun62RWjI" }, "results": { "languages": [ { "id": "Dy9Bk0bZlhLTbalWd1gP6", "language": "200", "code": "// Successfully rated customer usage records\n{\n \"error\": \"\",\n \"results\": [\n {\n \"referenceId\": \"\",\n \"subscriptionNumber\": \"\",\n \"lineItemId\": \"\",\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"subtotal\": 0,\n \"listTotal\": 0,\n \"quantity\": 0,\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"netSalesPrice\": 0,\n \"salesPrice\": 0,\n \"ratedCredit\": 0,\n \"success\": false,\n \"error\": \"\",\n \"orderItemId\": \"\",\n \"orderItemNumber\": \"\",\n \"orderNumber\": \"\",\n \"orderItemExternalId\": \"\",\n \"orderItemExternalName\": \"\",\n \"orderExternalName\": \"\"\n }\n ]\n}", "subExamples": [ { "label": "GENERATED", "code": "// Successfully rated customer usage records\n{\n \"error\": \"\",\n \"results\": [\n {\n \"referenceId\": \"\",\n \"subscriptionNumber\": \"\",\n \"lineItemId\": \"\",\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"subtotal\": 0,\n \"listTotal\": 0,\n \"quantity\": 0,\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"netSalesPrice\": 0,\n \"salesPrice\": 0,\n \"ratedCredit\": 0,\n \"success\": false,\n \"error\": \"\",\n \"orderItemId\": \"\",\n \"orderItemNumber\": \"\",\n \"orderNumber\": \"\",\n \"orderItemExternalId\": \"\",\n \"orderItemExternalName\": \"\",\n \"orderExternalName\": \"\"\n }\n ]\n}" }, { "label": "Successful Usage Rating Response", "code": "{\n \"error\": null,\n \"results\": [\n {\n \"referenceId\": \"e3c9e8eb-db44-4bce-898c-0f667163fd43\",\n \"subscriptionNumber\": \"SUB-00059394\",\n \"lineItemId\": \"d5294074-89fe-42f6-9a25-0fd5413cad17\",\n \"quantity\": 10,\n \"ratedCredit\": 20,\n \"success\": true\n }\n ]\n}" } ] }, { "id": "5HuW2ZJYlKqFDgrNVfOub", "language": "400", "code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "0OfQo3zJ3Ih8zAKQAdZ0t", "language": "404", "code": "// Not Found\n" }, { "id": "KGzb5hXn3HnTSdo1tXd7q", "language": "default", "code": "// default response\n{\n \"error\": \"\",\n \"results\": [\n {\n \"referenceId\": \"\",\n \"subscriptionNumber\": \"\",\n \"lineItemId\": \"\",\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"subtotal\": 0,\n \"listTotal\": 0,\n \"quantity\": 0,\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"netSalesPrice\": 0,\n \"salesPrice\": 0,\n \"ratedCredit\": 0,\n \"success\": false,\n \"error\": \"\",\n \"orderItemId\": \"\",\n \"orderItemNumber\": \"\",\n \"orderNumber\": \"\",\n \"orderItemExternalId\": \"\",\n \"orderItemExternalName\": \"\",\n \"orderExternalName\": \"\"\n }\n ]\n}", "subExamples": [ { "label": "GENERATED", "code": "// default response\n{\n \"error\": \"\",\n \"results\": [\n {\n \"referenceId\": \"\",\n \"subscriptionNumber\": \"\",\n \"lineItemId\": \"\",\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"subtotal\": 0,\n \"listTotal\": 0,\n \"quantity\": 0,\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"netSalesPrice\": 0,\n \"salesPrice\": 0,\n \"ratedCredit\": 0,\n \"success\": false,\n \"error\": \"\",\n \"orderItemId\": \"\",\n \"orderItemNumber\": \"\",\n \"orderNumber\": \"\",\n \"orderItemExternalId\": \"\",\n \"orderItemExternalName\": \"\",\n \"orderExternalName\": \"\"\n }\n ]\n}" }, { "label": "Price rate based on customer's usage.", "code": "{\n \"error\": null,\n \"results\": [\n {\n \"referenceId\": \"e3c9e8eb-db44-4bce-898c-0f667163fd43\",\n \"subscriptionNumber\": \"SUB-00059394\",\n \"lineItemId\": \"d5294074-89fe-42f6-9a25-0fd5413cad17\",\n \"quantity\": 10,\n \"ratedCredit\": 20,\n \"success\": true\n }\n ]\n}" } ] } ], "selectedLanguageId": "Dy9Bk0bZlhLTbalWd1gP6" } }, "children": [ { "text": "" } ] }