Deactivate usage meter

Authorizations

Authorization

string

header

required

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

Path Parameters

usage_meter_id

string

required

Maximum string length: 50

Example:

"um.1zYnCiM9Bpg.1zYn"

Response

Response for Create and Get usage event requests

Structure of usage meter

string

required

Identifier of the usage meter

Maximum string length: 20

name

string

required

Name of the usage meter

Maximum string length: 50

Example:

"rides-usage"

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 string length: 255

type

enum<string>

required

Type of usage meter

Available options:

COUNTER

Example:

"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 string length: 255

Example:

"Rides Usage"

description

string

Maximum string length: 255

Example:

"Meter to track cab rides"

filters

object[]

Show child attributes

filters.field

string

required

filters.value

string

required

status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

Example:

"DRAFT"

computations

object[]

Maximum array length: 1

Show child attributes

computations.computation

string

required

Computation to be applied on an event if it matches the matcher. In case of a COUNT aggregation type, computation should be passed as '1'

Maximum string length: 500

Example:

{
  "*": [{ "var": "attributes.distance" }, 0.4]
}

computations.order

integer

required

The order in which multiple matched computations will get evaluated

computations.id

string

Optional identifier describing the matcher and computation pair

Maximum string length: 50

computations.matcher

string

Condition to be applied on event. Upon matching it the corresponding computation will be considered for usage_meter unit calculation. The result of the matcher needs to be truthy in order to be considered as a match.

Maximum string length: 1500

Example:

"{\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"

eventSchema

object

Structure of an event schema

Show child attributes

eventSchema.name

string

required

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

Maximum string length: 50

eventSchema.version

integer<int32>

required

Version of event schema

Required range: x >= 1

Example:

1

eventSchema.description

string

Description of the event

Maximum string 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

Example:

"DRAFT"

eventSchema.attributes

object[]

Maximum array length: 50

Show child attributes

eventSchema.attributes.name

string

required

Name of the event attribute.

Maximum string length: 50

Example:

"distance"

eventSchema.attributes.defaultUnit

string

Unit for the attribute

Maximum string length: 10

Example:

"kms"

eventSchema.dimensions

object[]

Maximum array length: 50

Show child attributes

eventSchema.dimensions.name

string

required

Name of the event dimension

Maximum string length: 50

Example:

"city"

eventSchema.filterFields

string[]

eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

Show child attributes

eventSchema.featureDetails.featureId

string

required

eventSchema.featureDetails.attributeName

string

required

eventSchema.enrichments

object

Show child attributes

eventSchema.enrichments.fields

object[]

required

Show child attributes

eventSchema.enrichments.fields.name

string

required

eventSchema.enrichments.fields.type

enum<string>

required

Available options:

ATTRIBUTE,

DIMENSION

eventSchema.enrichments.fields.enrichmentType

enum<string>

required

Available options:

VALUE,

JSON_LOGIC,

JSON_LOGIC_FROM_DEPENDENCY

eventSchema.enrichments.fields.value

string

required

eventSchema.enrichments.fields.order

integer<int32>

required

eventSchema.enrichments.dependencies

object[]

Show child attributes

eventSchema.enrichments.dependencies.type

enum<string>

required

Available options:

SETTING

eventSchema.enrichments.dependencies.key

string

required

eventSchema.enrichments.dependencies.name

string

required

eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

eventSchema.eventLevelRevenue

boolean

eventSchema.createdAt

string<date-time>

eventSchema.updatedAt

string<date-time>

createdAt

string<date-time>

lastActivatedAt

string<date-time>

updatedAt

string<date-time>

Introduction

APIs

Authorizations

Path Parameters

Response