The Meter object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• customer_mappingobject

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

  Hide child attributes

  • customer_mapping.event_payload_keystring

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

  • customer_mapping.typeenum

    The method for mapping a meter event to a customer.

    Possible enum values

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

• default_aggregationobject

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

  Hide child attributes

  • default_aggregation.formulaenum

    Specifies how events are aggregated.

    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_namestring

  The meter’s name.

• event_namestring

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

• event_time_windownullable enum

  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.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• statusenum

  The meter’s status.

  Possible enum values

  active The meter is active.

  inactive The meter is inactive. No more events for this meter will be accepted. The meter cannot be attached to a price.

• status_transitionsobject

  The timestamps at which the meter status changed.

  Hide child attributes

  • status_transitions.deactivated_atnullable timestamp

    The time the meter was deactivated, if any. Measured in seconds since Unix epoch.

• updatedtimestamp

  Time at which the object was last updated. Measured in seconds since the Unix epoch.

• value_settingsobject

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

  Hide child attributes

  • value_settings.event_payload_keystring

    The key in the meter event payload to use as the value for this meter.