Stripe.Resources.V2.Billing.MeterEvent (tiger_stripe v0.4.0)

Copy Markdown View Source

Meter Event

A Meter Event is a usage record that captures billable activity for usage-based billing. Meter Events contain an event name, timestamp, and payload with customer mapping and usage value, enabling accurate usage tracking and billing.

Summary

Types

t()

Functions

object_name()

Types

t()

@type t() :: %Stripe.Resources.V2.Billing.MeterEvent{
  created: term(),
  event_name: term(),
  identifier: term(),
  livemode: term(),
  object: term(),
  payload: term(),
  timestamp: term()
}
  • created - The creation time of this meter event. Format: date-time.
  • event_name - The name of the meter event. Corresponds with the event_name field on a meter.
  • identifier - A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.
  • 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 of the object field. Possible values: v2.billing.meter_event.
  • payload - The payload of the event. This must contain the fields corresponding to a meter's customer_mapping.event_payload_key (default is stripe_customer_id) and value_settings.event_payload_key (default is value). Read more about the payload..
  • timestamp - The time of the event. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified. Format: date-time.

Functions

object_name()