Update an usage meter

Authorizations

Authorization

string

headerrequired

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

Path Parameters

usage_meter_id

string

required

Maximum length: 50

Body

application/json

Request to update usage meter

name

string

Name of usage meter.

Maximum length: 255

billableName

string

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

Maximum length: 255

description

string

Description of the usage meter

Maximum length: 255

eventSchemaName

string

Event Schema Identifier

type

enum<string>

Type of usage meter

COUNTER - Count usage

Available options:

COUNTER

aggregation

enum<string>

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

Available options:

COUNT,

SUM

computations

object[]

filters

object[]

Response

200 - application/json

Structure of usage meter

string

required

Identifier of the usage meter

Maximum length: 20

name

string

required

Name of the usage meter

Maximum length: 50

displayName

string

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.

Maximum length: 255

type

enum<string>

required

Type of usage meter

Available options:

COUNTER

aggregation

enum<string>

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

Available options:

COUNT,

SUM

billableName

string

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

Maximum length: 255

description

string

Maximum length: 255

filters

object[]

status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

computations

object[]

eventSchema

object

Structure of an event schema

eventSchema.name

string

required

Name of the event. Must be unique for an organization.

Maximum length: 50

eventSchema.version

integer

required

Version of event schema

Required range: x > 1

eventSchema.description

string

Description of the event

Maximum length: 255

eventSchema.status

enum<string>

Status of event schema

DRAFT - Schema is in draft state
ACTIVE - Schema is currently active
INACTIVE - Schema is currently inactive
ARCHIVED - Older version of event schema

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

eventSchema.attributes

object[]

eventSchema.dimensions

object[]

eventSchema.filterFields

string[]

eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

eventSchema.enrichments

object

eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

eventSchema.eventLevelRevenue

boolean

eventSchema.createdAt

string

eventSchema.updatedAt

string

createdAt

string

lastActivatedAt

string

updatedAt

string

Introduction

APIs

Authorizations

Path Parameters

Body

Response