Amberflo · Schema

MeterDefinitionRequest

Request body for creating a meter definition

Usage-Based BillingMeteringFinOpsAI Cost ManagementBillingMonetization

Properties

Name Type Description
meterApiName string Unique API name for the meter
displayName string Human-readable display name
type string Aggregation type for the meter
dimensions array Dimension names for this meter
View JSON Schema on GitHub

JSON Schema

metering-meter-definition-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amberflo/refs/heads/main/json-schema/metering-meter-definition-request-schema.json",
  "title": "MeterDefinitionRequest",
  "description": "Request body for creating a meter definition",
  "type": "object",
  "properties": {
    "meterApiName": {
      "type": "string",
      "description": "Unique API name for the meter",
      "example": "api-calls"
    },
    "displayName": {
      "type": "string",
      "description": "Human-readable display name",
      "example": "API Calls"
    },
    "type": {
      "type": "string",
      "description": "Aggregation type for the meter",
      "enum": [
        "SUM_OF_ALL_USAGE",
        "MAX_IN_PERIOD",
        "UNIQUE_CUSTOMERS_COUNT"
      ],
      "example": "SUM_OF_ALL_USAGE"
    },
    "dimensions": {
      "type": "array",
      "description": "Dimension names for this meter",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "meterApiName",
    "displayName",
    "type"
  ]
}