# Update a usage product inventory Endpoint: PATCH /usage-product-inventories/{usage_product_inventory_id} Version: 2.24 Security: bearerAuth ## Path parameters: - `usage_product_inventory_id` (integer, required) Usage product inventory identifier Example: 1 ## Request fields (application/json-patch+json): - `op` (string, required) The JSON Patch operation to be performed Enum: "add", "remove", "replace", "move", "copy", "test" - `path` (string, required) A JSON-Pointer - `value` (object) The value to be used within the operations - `from` (string) A string containing a JSON Pointer value ## Response 200 fields (application/json): - `id` (integer) Usage product inventory identifier Example: 1 - `siteId` (integer, required) Site identifier Example: 1 - `usageProductId` (integer, required) Usage product identifier Example: 1 - `startDate` (string, required) Start date - `endDate` (string) End date - `supplierAccountId` (integer) Supplier account identifier - `billByServiceId` (boolean) Bill by Service ID - `serviceId` (string) Service ID. Extra validations may be applied depending on product configurations - `billable` (boolean) Billable charge - `inFlightOrder` (boolean) In-flight order - `externalOrderReference` (string) external order reference - `externalNetworkOrderReference` (string) external Network order reference - `pendingEndDate` (string) Inflight order pending end date - `usageCapEnabled` (boolean) Usage cap enabled - `defaultUsageCap` (number) Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD) - `overrideUsageCap` (number) Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD) - `applySurcharges` (boolean) Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost - `productReferences` (array, required) - `productReferences.id` (integer) Product reference identifier Example: 1 - `productReferences.productReference` (string, required) Product reference. Extra validations may be applied depending on product configurations. - `productReferences.primary` (boolean) True if product reference is primary (main billing number) - `productReferences.label` (string) Product reference - `productReferences.userId` (string) User Id - `productReferences.userEmail` (string) User email address - `productReferences.costCentreCode` (string) Cost centre code - `productReferences.departmentCode` (string) Department code - `productReferences.notes` (string) Notes - `tripwirePlanId` (integer) Tripwire plan identifier ## Response 400 fields ## Response 401 fields ## Response 403 fields ## Response 404 fields