WebhookEventType enum - types library

Values

SubscriptionStarted → const WebhookEventType: Initial purchase or first conversion from a free trial / intro offer. iOS: SUBSCRIBED (initialBuy / resubscribe). Android: SUBSCRIPTION_PURCHASED.

const WebhookEventType('subscription-started')
SubscriptionRenewed → const WebhookEventType: Auto-renewal succeeded for an existing subscription. iOS: DID_RENEW. Android: SUBSCRIPTION_RENEWED.

const WebhookEventType('subscription-renewed')
SubscriptionExpired → const WebhookEventType: Subscription reached its expiration without a successful renewal. iOS: EXPIRED. Android: SUBSCRIPTION_EXPIRED.

const WebhookEventType('subscription-expired')
SubscriptionInGracePeriod → const WebhookEventType: Billing failed; the subscription is in a grace period during which the user retains entitlement while payment is retried. iOS: DID_FAIL_TO_RENEW (with grace period active). Android: SUBSCRIPTION_IN_GRACE_PERIOD.

const WebhookEventType('subscription-in-grace-period')
SubscriptionInBillingRetry → const WebhookEventType: Billing failed and the subscription is in account-hold / billing retry, during which entitlement is paused but the subscription is not yet expired. iOS: DID_FAIL_TO_RENEW (no grace period; billing retry). Android: SUBSCRIPTION_ON_HOLD.

const WebhookEventType('subscription-in-billing-retry')
SubscriptionRecovered → const WebhookEventType: Subscription returned to active state after a billing issue or pause. iOS: DID_RECOVER. Android: SUBSCRIPTION_RECOVERED (1) only — RESTARTED (7) is auto- renew re-enabled (Uncanceled), not billing recovery.

const WebhookEventType('subscription-recovered')
SubscriptionCanceled → const WebhookEventType: User turned off auto-renew. Access continues until the current period ends. iOS: DID_CHANGE_RENEWAL_STATUS (autoRenew turned off). Android: SUBSCRIPTION_CANCELED.

const WebhookEventType('subscription-canceled')
SubscriptionUncanceled → const WebhookEventType: User reactivated auto-renew before the subscription expired. iOS: DID_CHANGE_RENEWAL_STATUS (autoRenew turned on). Android: SUBSCRIPTION_RESTARTED (when re-enabled, not after billing recovery).

const WebhookEventType('subscription-uncanceled')
SubscriptionRevoked → const WebhookEventType: Access immediately revoked (family sharing removal, admin action, fraud). iOS: REVOKE. Android: SUBSCRIPTION_REVOKED.

const WebhookEventType('subscription-revoked')
SubscriptionPriceChange → const WebhookEventType: A price change is pending or has been confirmed by the user. iOS: PRICE_INCREASE. Android: SUBSCRIPTION_PRICE_CHANGE_CONFIRMED.

const WebhookEventType('subscription-price-change')
SubscriptionProductChanged → const WebhookEventType: User upgraded, downgraded, or crossgraded their plan. iOS: DID_CHANGE_RENEWAL_PREF. Android: SUBSCRIPTION_DEFERRED / SUBSCRIPTION_PRODUCT_CHANGED.

const WebhookEventType('subscription-product-changed')
SubscriptionPaused → const WebhookEventType: Subscription paused (Android only feature). Also fired when the pause schedule is changed — RTDN does not have a separate signal. Android: SUBSCRIPTION_PAUSED (10), SUBSCRIPTION_PAUSE_SCHEDULE_CHANGED (11).

const WebhookEventType('subscription-paused')
SubscriptionResumed → const WebhookEventType: Paused subscription resumed (Android only feature). RTDN signals resume via SUBSCRIPTION_RECOVERED (1) once the next billing cycle starts; PAUSE_SCHEDULE_CHANGED is the schedule update, not the resume. Android: SUBSCRIPTION_RECOVERED (after pause).

const WebhookEventType('subscription-resumed')
PurchaseRefunded → const WebhookEventType: Refund issued for a one-time purchase or subscription period. iOS: REFUND. Android: ONE_TIME_PRODUCT_REFUNDED / VOIDED_PURCHASE.

const WebhookEventType('purchase-refunded')
PurchaseConsumptionRequest → const WebhookEventType: iOS-only: App Store requests a consumption status report for a refund decision. Servers should respond via the StoreKit consumption API.

const WebhookEventType('purchase-consumption-request')
TestNotification → const WebhookEventType: Sandbox or test notification fired by the store for diagnostic purposes. Useful for verifying webhook plumbing without a live transaction.

const WebhookEventType('test-notification')

Properties

hashCode → int: The hash code for this object.
no setterinherited
index → int: A numeric identifier for the enumerated value.
no setterinherited
name → String: Available on Enum, provided by the EnumName extension
The name of the enum value.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
value → String: final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson() → String
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

values → const List<WebhookEventType>: A constant List of the values in this enum, in order of their declaration.