Create an usage meter
Create an usage meter and associate with an event schema
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Request to create usage meter
Name of the usage meter. Must be unique for an organization.
Billable name of usage meter. Billable name takes precedence over name to display in invoice.
Description of the usage meter
The usage meter's applicability will be determined by comparing the filter condition agianst the events.
Type of usage meter
COUNTER
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
COUNT
, SUM
Event Schema Identifier
Response
Structure of usage meter
Identifier of the usage meter
Name of the usage meter
Billable name of addon. Billable name takes precedence over name to display in invoice.
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.
Type of usage meter
COUNTER
Status of usage meter
DRAFT
, ACTIVE
, INACTIVE
, ARCHIVED
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
COUNT
, SUM
Structure of an event schema