Create a billing meter 

Creates a billing meter.

Parameters

• default_aggregationobjectRequired

  The default settings to aggregate a meter’s events with.

  Hide child parameters

  • default_aggregation.formulaenumRequired

    Specifies how events are aggregated. Allowed values are count to count the number of events, sum to sum each event’s value and last to take the last event’s value in the window.

    Possible enum values

    count Count the number of events.

    last Take the last event’s value in the window.

    sum Sum each event’s value.

• display_namestringRequired

  The meter’s name. Not visible to the customer.

• event_namestringRequired

  The name of the meter event to record usage for. Corresponds with the event_name field on meter events.

• customer_mappingobject

  Fields that specify how to map a meter event to a customer.

  Hide child parameters

  • customer_mapping.event_payload_keystringRequired

    The key in the meter event payload to use for mapping the event to a customer.

  • customer_mapping.typeenumRequired

    The method for mapping a meter event to a customer. Must be by_id.

    Possible enum values

    by_id Map a meter event to a customer by passing a customer ID in the event’s payload.

• event_time_windowenum

  The time window which meter events have been pre-aggregated for, if any.

  Possible enum values

  day Events are pre-aggregated in daily buckets.

  hour Events are pre-aggregated in hourly buckets.

• value_settingsobject

  Fields that specify how to calculate a meter event’s value.

  Hide child parameters

  • value_settings.event_payload_keystringRequired

    The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a bytes_used field, then set the event_payload_key to “bytes_used”.