PolarExpress.Events.BenefitGrantCycled (polar_express v0.1.5)

Webhook event for benefit_grant.cycled.

Sent when a benefit grant is cycled, meaning the related subscription has been renewed for another period.

Discord & Slack support: Basic

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

Summary

Types

t()

Functions

event_type()

Returns the event type string.

Types

t()

@type t() :: %PolarExpress.Events.BenefitGrantCycled{
  data: PolarExpress.Schemas.BenefitGrantWebhook.t(),
  timestamp: String.t(),
  type: String.t()
}

type - Always "benefit_grant.cycled".
data - The event payload. See PolarExpress.Schemas.BenefitGrantWebhook.
timestamp - ISO 8601 timestamp of when the event occurred.

Functions

event_type()

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

Returns the event type string.