Create a meter value calculation | Solvimon

curl -X POST 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",
  "calculation_type": "SUM",
  "meter_id": "metr_kwDeeN0tv5UDtxADed1o",
  "name": "Receipt scanning",
  "description": "Meter value calculation of the scanning of receipts",
  "persist": false,
  "meter_value_id": "metv_gwDeeN0tv5UxbHANeD1k",
  "meter_property_id": "metp_pwDeeN0tfldtVBAXeN1e"
}'

{
  "object_type": "METER_VALUE_CALCULATION",
  "id": "mvc_9f8e7d6c5b4a3e2f1d0c",
  "reference": "meter_value_calculation_receipt_scan",
  "name": "Receipt scanning",
  "description": "Meter value calculation of the scanning of receipts",
  "calculation_type": "SUM",
  "persist": true,
  "meter_id": "metr_kwDeeN0tv5UDtxADed1o",
  "meter": {
    "object_type": "METER",
    "id": "metr_kwDeeN0tv5UDtxADed1o",
    "reference": "meter_receipt_scanner",
    "name": "Receipt Scanner Meter",
    "description": "Meter tracking receipt scanning events",
    "status": "ACTIVE",
    "meter_values": [
      {
        "id": "metv_gwDeeN0tv5UxbHANeD1k",
        "object": {
          "object_type": "METER_VALUE",
          "id": "metv_gwDeeN0tv5UxbHANeD1k",
          "reference": "receipt_count",
          "name": "Receipt Count",
          "description": "Number of receipts scanned",
          "status": "ACTIVE",
          "type": "NUMBER"
        },
        "required": true
      }
    ],
    "meter_properties": [
      {
        "id": "metp_pwDeeN0tfldtVBAXeN1e",
        "object": {
          "object_type": "METER_PROPERTY",
          "id": "metp_pwDeeN0tfldtVBAXeN1e",
          "reference": "scan_quality",
          "name": "Scan Quality",
          "description": "Quality of the receipt scan",
          "status": "ACTIVE",
          "type": "ENUM",
          "enum_values": [
            "LOW",
            "MEDIUM",
            "HIGH"
          ]
        },
        "required": true
      }
    ]
  },
  "meter_value_id": "metv_gwDeeN0tv5UxbHANeD1k",
  "meter_value": {
    "object_type": "METER_VALUE",
    "id": "metv_gwDeeN0tv5UxbHANeD1k",
    "reference": "receipt_count",
    "name": "Receipt Count",
    "description": "Number of receipts scanned",
    "status": "ACTIVE",
    "type": "NUMBER"
  },
  "meter_property_id": "metp_pwDeeN0tfldtVBAXeN1e",
  "meter_property": {
    "object_type": "METER_PROPERTY",
    "id": "metp_pwDeeN0tfldtVBAXeN1e",
    "reference": "scan_quality",
    "name": "Scan Quality",
    "description": "Quality of the receipt scan",
    "status": "ACTIVE",
    "type": "ENUM",
    "enum_values": [
      "LOW",
      "MEDIUM",
      "HIGH"
    ]
  }
}

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

Headers

x-platform-idstringOptional

Platform ID.

Request

This endpoint expects an object.

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

calculation_typeenum or nullRequired

The type of calculation used for this billable metric.

Allowed values:

meter_idstring or nullRequired

The ID of the meter.

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

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

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).

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

Created

object_typestring or nullRead-only

idstring or nullRead-only

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

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

409

Conflict Error

500

Internal Server Error