StripeElixir.Params.V2.Billing.MeterEventStreamCreateStreamParams.Events (stripe_elixir v0.1.0)

Copy Markdown View Source

Nested parameters.

Summary

Types

t()

Types

t()

@type t() ::
  %StripeElixir.Params.V2.Billing.MeterEventStreamCreateStreamParams.Events{
    event_name: String.t() | nil,
    identifier: String.t() | nil,
    payload: map() | nil,
    timestamp: String.t() | nil
  }
  • 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.
  • 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.