POST
/
usage_meters
/
{usage_meter_id}
/
deactivate

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 length: 50

Response

200 - application/json

Structure of usage meter

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
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
id
string
required

Identifier of the usage meter

Maximum length: 20
name
string
required

Name of the usage meter

Maximum length: 50
type
enum<string>
required

Type of usage meter

Available options:
COUNTER
billableName
string

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

Maximum length: 255
computations
object[]
createdAt
string
description
string
Maximum length: 255
eventSchema
object

Structure of an event schema

filters
object[]
lastActivatedAt
string
status
enum<string>

Status of usage meter

Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
updatedAt
string