View Source Stripe.Billing.MeterEvent (stripity_stripe v3.3.1)

Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.

Summary

Types

t()

The billing.meter_event type.

Functions

create(params \\ %{}, opts \\ [])

Creates a billing meter event.

Types

Link to this type

t()

View Source 
@type t() :: %Stripe.Billing.MeterEvent{
  created: integer(),
  event_name: binary(),
  identifier: binary(),
  livemode: boolean(),
  object: binary(),
  payload: term(),
  timestamp: integer()
}

The billing.meter_event type.

  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • event_name The name of the meter event. Corresponds with the event_name field on a meter.
  • identifier A unique identifier for the event.
  • 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.
  • payload The payload of the event. This contains 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 timestamp passed in when creating the event. Measured in seconds since the Unix epoch.

Functions

Link to this function

create(params \\ %{}, opts \\ [])

View Source 
@spec create(
  params :: %{
    optional(:event_name) => binary(),
    optional(:expand) => [binary()],
    optional(:identifier) => binary(),
    optional(:payload) => map(),
    optional(:timestamp) => integer()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a billing meter event.

Details

  • Method: post
  • Path: /v1/billing/meter_events