Update a meter value calculation | Solvimon

curl -X PATCH https://test.api.solvimon.com/v1/meter-value-calculations/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "meter_value_calculation_receipt_scan",
  "name": "Receipt scanning",
  "description": "Meter value calculation of the scanning of receipts",
  "calculation_type": "SUM",
  "persist": false,
  "meter_id": "metr_kwDeeN0tv5UDtxADed1o",
  "meter_value_id": "metv_gwDeeN0tv5UxbHANeD1k",
  "meter_property_id": "metp_pwDeeN0tfldtVBAXeN1e"
}'

{
  "reference": "meter_value_calculation_receipt_scan",
  "object_type": "meter_value_calculation",
  "id": "mvc_9f8e7d6c5b4a3e2f1d0c",
  "name": "Receipt scanning",
  "description": "Meter value calculation of the scanning of receipts",
  "calculation_type": "SUM",
  "persist": true,
  "meter_id": "metr_kwDeeN0tv5UDtxADed1o",
  "meter": {
    "reference": "meter_receipt_scanner",
    "object_type": "meter",
    "id": "metr_kwDeeN0tv5UDtxADed1o",
    "name": "Receipt Scanner Meter",
    "description": "Tracks the number of receipts scanned per day",
    "status": "ACTIVE",
    "meter_values": [
      {
        "id": "metv_gwDeeN0tv5UxbHANeD1k",
        "object": {
          "reference": "daily_scan_count",
          "object_type": "meter_value",
          "id": "metv_gwDeeN0tv5UxbHANeD1k",
          "name": "Daily Scan Count",
          "description": "Number of receipts scanned each day",
          "status": "ACTIVE",
          "type": "NUMBER"
        },
        "required": true
      }
    ],
    "meter_properties": [
      {
        "id": "metp_pwDeeN0tfldtVBAXeN1e",
        "object": {
          "reference": "scan_quality",
          "status": "ACTIVE",
          "object_type": "meter_property",
          "id": "metp_pwDeeN0tfldtVBAXeN1e",
          "name": "Scan Quality",
          "description": "Quality rating of the scanned receipt images",
          "type": "ENUM",
          "enum_values": [
            "poor",
            "average",
            "good",
            "excellent"
          ]
        },
        "required": true
      }
    ]
  },
  "meter_value_id": "metv_gwDeeN0tv5UxbHANeD1k",
  "meter_value": {
    "reference": "daily_scan_count",
    "object_type": "meter_value",
    "id": "metv_gwDeeN0tv5UxbHANeD1k",
    "name": "Daily Scan Count",
    "description": "Number of receipts scanned each day",
    "status": "ACTIVE",
    "type": "NUMBER"
  },
  "meter_property_id": "metp_pwDeeN0tfldtVBAXeN1e",
  "meter_property": {
    "reference": "scan_quality",
    "status": "ACTIVE",
    "object_type": "meter_property",
    "id": "metp_pwDeeN0tfldtVBAXeN1e",
    "name": "Scan Quality",
    "description": "Quality rating of the scanned receipt images",
    "type": "ENUM",
    "enum_values": [
      "poor",
      "average",
      "good",
      "excellent"
    ]
  }
}

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

namestring or nullOptionalformat: "^.*$"0-256 characters

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

calculation_typeenum or nullOptional

The type of calculation used for this billable metric.

Allowed values:

persistboolean or nullOptional

Indicate if the data of the billable metric must be persisted to the next billing period of the schedule (default is false).

meter_idstring or nullOptional

The ID of the meter.

meterobject or nullOptional

meter_value_idstring or nullOptional

The ID of the meter value.

meter_valueobject or nullOptional

meter_property_idstring or nullOptional

The ID of the meter property.

meter_propertyobject or nullOptional

Response

referencestringformat: "^\S+$"0-256 characters

object_typestring or nullRead-only

idstring or nullRead-only

namestring or nullformat: "^.*$"0-256 characters

descriptionstring or nullformat: "^.*$"0-256 characters

calculation_typeenum or null

The type of calculation used for this billable metric.

Allowed values:

persistboolean or null

Indicate if the data of the billable metric must be persisted to the next billing period of the schedule (default is false).

meter_idstring or null

The ID of the meter.

meterobject or null

meter_value_idstring or null

The ID of the meter value.

meter_valueobject or null

meter_property_idstring or null

The ID of the meter property.

meter_propertyobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors