PolarExpress.Events.CheckoutExpired (polar_express v0.1.5)

Copy Markdown View Source

Webhook event for checkout.expired.

Sent when a checkout expires.

This event fires when a checkout reaches its expiration time without being completed. Developers can use this to send reminder emails or track checkout abandonment.

Discord & Slack support: Basic

The data field contains a PolarExpress.Schemas.Checkout struct.

Summary

Functions

Returns the event type string.

Types

t()

@type t() :: %PolarExpress.Events.CheckoutExpired{
  data: PolarExpress.Schemas.Checkout.t(),
  timestamp: String.t(),
  type: String.t()
}
  • type - Always "checkout.expired".
  • data - The event payload. See PolarExpress.Schemas.Checkout.
  • timestamp - ISO 8601 timestamp of when the event occurred.

Functions

event_type()

@spec event_type() :: String.t()

Returns the event type string.