StripeElixir.Resources.Billing.Meter (stripe_elixir v0.1.0)

Copy Markdown View Source

BillingMeter

Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.

Related guide: Usage based billing

Summary

Types

t()

Functions

expandable_fields()
object_name()

Types

t()

@type t() :: %StripeElixir.Resources.Billing.Meter{
  created: integer(),
  customer_mapping: map(),
  default_aggregation: map(),
  display_name: String.t(),
  event_name: String.t(),
  event_time_window: String.t(),
  id: String.t(),
  livemode: boolean(),
  object: String.t(),
  status: String.t(),
  status_transitions: map(),
  updated: integer(),
  value_settings: map()
}
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • customer_mapping - Expandable.
  • default_aggregation - Expandable.
  • display_name - The meter's name. Max length: 5000.
  • event_name - The name of the meter event to record usage for. Corresponds with the event_name field on meter events. Max length: 5000.
  • event_time_window - The time window which meter events have been pre-aggregated for, if any. Possible values: day, hour. Nullable.
  • id - Unique identifier for the object. Max length: 5000.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: billing.meter.
  • status - The meter's status. Possible values: active, inactive.
  • status_transitions - Expandable.
  • updated - Time at which the object was last updated. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • value_settings - Expandable.

Functions

expandable_fields()

object_name()