Stripe.Resources.Billing.Meter (tiger_stripe v0.3.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

customer_mapping()
default_aggregation()
status_transitions()
t()
value_settings()

Functions

expandable_fields()
object_name()

Types

customer_mapping()

@type customer_mapping() :: %{
  optional(:event_payload_key) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • event_payload_key - The key in the meter event payload to use for mapping the event to a customer. Max length: 5000.
  • type - The method for mapping a meter event to a customer. Possible values: by_id.

default_aggregation()

@type default_aggregation() :: %{
  optional(:formula) => String.t() | nil,
  optional(String.t()) => term()
}
  • formula - Specifies how events are aggregated. Possible values: count, last, sum.

status_transitions()

@type status_transitions() :: %{
  optional(:deactivated_at) => integer() | nil,
  optional(String.t()) => term()
}
  • deactivated_at - The time the meter was deactivated, if any. Measured in seconds since Unix epoch. Format: Unix timestamp. Nullable.

t()

@type t() :: %Stripe.Resources.Billing.Meter{
  created: integer(),
  customer_mapping: customer_mapping(),
  default_aggregation: default_aggregation(),
  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: status_transitions(),
  updated: integer(),
  value_settings: value_settings()
}
  • 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.

value_settings()

@type value_settings() :: %{
  optional(:event_payload_key) => String.t() | nil,
  optional(String.t()) => term()
}
  • event_payload_key - The key in the meter event payload to use as the value for this meter. Max length: 5000.

Functions

expandable_fields()

object_name()