Skip to main content

Interface: ISubscriptionHookValue

Defined in: src/providers/react/types/hook-contracts.ts:78

Shape returned by the subscription hook.

Remarks​

Maps to useSubscription() from the monetization provider.

Properties​

expirationDate?​

optional expirationDate?: string

Defined in: src/providers/react/types/hook-contracts.ts:90

ISO date string when the subscription expires

isSubscribed​

isSubscribed: boolean

Defined in: src/providers/react/types/hook-contracts.ts:80

Whether the user holds an active subscription

isTrialLimitReached?​

optional isTrialLimitReached?: boolean

Defined in: src/providers/react/types/hook-contracts.ts:92

Whether the user has exhausted their trial eligibility

isUnderFreeTrial?​

optional isUnderFreeTrial?: boolean

Defined in: src/providers/react/types/hook-contracts.ts:88

Whether the user is currently on a free trial

status​

status: string

Defined in: src/providers/react/types/hook-contracts.ts:84

Subscription lifecycle status

subscriptionPeriod?​

optional subscriptionPeriod?: string

Defined in: src/providers/react/types/hook-contracts.ts:86

Billing period (e.g. "monthly", "yearly")

tierId​

tierId: string

Defined in: src/providers/react/types/hook-contracts.ts:82

Subscription tier identifier