POST
/
usage_meters

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required

Name of the usage meter. Must be unique for an organization.

billableName
string

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

description
string

Description of the usage meter

filters
object[]

The usage meter's applicability will be determined by comparing the filter condition agianst the events.

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
computations
object[]
eventSchemaName
string

Event Schema Identifier

Response

201 - application/json
id
string
required

Identifier of the usage meter

name
string
required

Name of the usage meter

billableName
string

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

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.

description
string
filters
object[]
type
enum<string>
required

Type of usage meter

Available options:
COUNTER
status
enum<string>

Status of usage meter

Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
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
computations
object[]
createdAt
string
lastActivatedAt
string
updatedAt
string
List usage meters for event schemaGet usage meter