Usage Meters
Activate usage meter
Activate usage meter
POST
/
usage_meters
/
{usage_meter_id}
/
activate
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
usage_meter_id
string
requiredResponse
200 - application/json
id
string
requiredIdentifier of the usage meter
name
string
requiredName of the usage meter
billableName
string
Billable name of addon. Billable name takes precedence over name to display in invoice.
displayName
string
requiredDisplay 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>
requiredType of usage meter
Available options:
COUNTER
status
enum<string>
Status of usage meter
Available options:
DRAFT
, ACTIVE
, INACTIVE
, ARCHIVED
aggregation
enum<string>
requiredAggregation 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