Usage Meters

Update an usage meter

This API lets you update an existing usage meter.

patch/usage_meters/{usage_meter_id}

Path parameters

usage_meter_idstring required

Example:um.1zYnCiM9Bpg.1zYn

Request body

namestring

Name of usage meter.

billableNamestring

Billable name of usage meter. Billable name takes precedence over name to display in invoice.

descriptionstring

Description of the usage meter

eventSchemaNamestring

Event Schema Identifier

type'COUNTER'

Type of usage meter

COUNTER - Count usage

aggregation'COUNT' | 'SUM'

Aggregation to be applied on usage meter result

COUNT - Counts number of events matching the usage meter
SUM - Sums up results of computation of all events matching usage meter

Example request

{
  "type": "COUNTER",
  "computations": [
    {
      "matcher": "{\n  \"and\": [\n    {\"in\": [{\"var\": \"dimension.city\"}, \"chennai\", \"mumbai\"]},\n    \"or\": [\n      {\">\": [{\"var\": \"attribute.distance\"}, 100]},\n      {\"<\": [{\"var\": \"attribute.distance\"}, 20]}\n    ]\n  ]\n}\n"
    }
  ]
}

Response

Response for Create and Get usage event requests

idstring required

Identifier of the usage meter

namestring required

Name of the usage meter

billableNamestring

Billable name of addon. Billable name takes precedence over name to display in invoice.

displayNamestring required

Display name of usage meter. This is an auto-generated field which contains billableName of usage meter. If billableName is not provided, name will be used as display name.

descriptionstring

type'COUNTER' required

Type of usage meter

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED'

Status of usage meter

aggregation'COUNT' | 'SUM' required

Aggregation to be applied on usage meter result

COUNT - Counts number of events matching the usage meter
SUM - Sums up results of computation of all events matching usage meter

createdAtstring date-time

lastActivatedAtstring date-time

updatedAtstring date-time

Example response

{
  "name": "rides-usage",
  "billableName": "Rides Usage",
  "description": "Meter to track cab rides",
  "type": "COUNTER",
  "status": "DRAFT",
  "computations": [
    {
      "matcher": "{\n  \"and\": [\n    {\"in\": [{\"var\": \"dimension.city\"}, \"chennai\", \"mumbai\"]},\n    \"or\": [\n      {\">\": [{\"var\": \"attribute.distance\"}, 100]},\n      {\"<\": [{\"var\": \"attribute.distance\"}, 20]}\n    ]\n  ]\n}\n"
    }
  ]
}

Changes

Changed in 5 of the 34 revisions of this API.167

May 27, 20242b8be460ec6a2See the full diff
- ○
  added the new optional request property filters
  new-optional-request-property
- ○
  added the optional property filters to the response with the 200 status
  response-optional-property-added
Mar 1, 20246fb940b0dad91See the full diff
- ○
  added the new optional request property eventSchemaName
  new-optional-request-property
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 30, 2023b3351be4b4621See the full diff
- ○
  added the required property displayName to the response with the 200 status
  response-required-property-added
Nov 3, 2023a6c96c5ec06e3See the full diff
- ○
  added the new optional request property billableName
  new-optional-request-property
- ○
  added the new optional request property name
  new-optional-request-property
- ○
  added the optional property billableName to the response with the 200 status
  response-optional-property-added
Sep 2, 20236b13f6f4773516See the full diff
- ▲
  removed the required property displayName from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property billableName
  request-property-removed
- ●
  removed the request property eventSchemaName
  request-property-removed
- ●
  removed the request property filters
  request-property-removed
- ●
  removed the request property name
  request-property-removed
- ●
  removed the optional property billableName from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property filters from the response with the 200 status
  response-optional-property-removed
This revision also has 74 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history