Docs / wallet / AppSubscriptionStatus

AppSubscriptionStatus

typesince 0.3.0

The end-user's subscription state for one app: status and billing period — status-only since 0.3.3/P0-167 (P0-162).

import type { AppSubscriptionStatus } from 'flowstack-sdk/paywall'

The subscription field of useAppAccess(). Since 0.3.3 (P0-167) a subscription is pure ACCESS: an open paid period means full access with no per-plan query allowance (compute is funded by the app owner at 1 credit/query). queriesUsed/queriesPerMonth were REMOVED in 0.3.3 — code reading them gets undefined.

Signature

interface AppSubscriptionStatus

Returns

FieldTypeDescription
state'none' | 'active' | 'past_due' | 'canceled''none' = never subscribed. 'past_due' rides Stripe's retry window (access continues). 'canceled' works until currentPeriodEnd.
currentPeriodEndstring | nullISO timestamp the current billing period ends.
cancelAtPeriodEndbooleanTrue after cancelSubscription() — the plan will not renew.
labelstring | nullBuilder's plan label, e.g. "$5/mo — full access". Defaults to a derived label.
WarningBREAKING in 0.3.3 (P0-167): queriesUsed and queriesPerMonth no longer exist — subscription access is status-only. Do not render allowance meters from this type; an open period (state active/past_due/canceled with currentPeriodEnd in the future) means full access.

See also

useAppAccess · AppPaywall · subscribeToApp · cancelAppSubscription · MonetizationSubscriptionConfig

Source: src/wallet/types.ts (P0-162) · Also available in llms-full.txt and registry.json.