PolarExpress.Events.SubscriptionPastDue (polar_express v0.1.5)

Webhook event for subscription.past_due.

Sent when a subscription payment fails and the subscription enters past_due status.

This is a recoverable state - the customer can update their payment method to restore the subscription. Benefits may be revoked depending on the organization's grace period settings.

If payment retries are exhausted, a subscription.revoked event will be sent.

Discord & Slack support: Full

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

Summary

Types

t()

Functions

event_type()

Returns the event type string.

Types

t()

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

type - Always "subscription.past_due".
data - The event payload. See PolarExpress.Schemas.Subscription.
timestamp - ISO 8601 timestamp of when the event occurred.

Functions

event_type()

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

Returns the event type string.