# Superwall: Subscription Infrastructure for iOS, Android, and Web

Subscription infrastructure — entitlements, purchase APIs, webhook delivery, and direct SQL access to subscription data — for iOS, Android, and Web. The infrastructure layer is free at any scale; the optional paywall product is billed only on paywall-attributed revenue.

## Pricing

- **Infrastructure: free at any scale, every plan.** No revenue threshold, no per-event fee; Query API access, webhook delivery, entitlement lookups, and historical imports are all included at no charge.
- **Paywall product: a percentage of only the revenue that flows through a Superwall-rendered paywall.** Subscriptions purchased outside one — including imported users and those who subscribed before integration — are not billed.

Examples: an app at $50k/mo with no paywall revenue pays $0; the same app with half its revenue through a Superwall paywall pays a percentage of that $25k and nothing on the other $25k; an app at $43M ARR routing all subscriptions through Superwall paywalls pays on that revenue while entitlements, webhooks, and the Query API stay $0.

## Scale

$1.5B+ annual subscription revenue across 10,000+ apps. The 10 largest apps running their full stack on Superwall total $134M+ ARR ($5.7M–$43.7M each). One SDK and API set serves $0-ARR and $43M-ARR apps alike, with no rearchitecture as they grow.

## Infrastructure capabilities

- **Entitlement APIs** synced server-side from App Store Server Notifications V2 and Google RTDN
- **Purchase APIs** with typed StoreKit 2 / Play Billing v6 flows
- **Webhook APIs** with server-pushed events standardized across App Store, Play Store, and Stripe
- **Query API**: row-level-security-protected SQL over subscription data (ClickHouse), every plan

Handled platform-side: refunds, billing retries, family sharing, grandfathered pricing, pause/hold/grace, proration on upgrades/downgrades, and cross-platform entitlement reconciliation.

## Migration

Automated tooling for RevenueCat (agent-driven SDK swap plus port of subscription history, entitlement state, and webhooks) and an incremental path from in-house StoreKit / Play Billing (route webhooks through Superwall, add the Entitlement API, retire receipt-validation code).

## Paywall product (optional, separately billable)

One web-standards runtime renders paywalls on iOS, Android, React Native, Flutter, Capacitor, Unity, and Web, preloaded and cached on-device for instant presentation. Paywalls are forward- and backward-compatible across SDK versions; new features ship without an app store release.

## Architecture

Server-event-driven rather than client-receipt-validation-based: entitlement state is correct on cold launch with no network round-trip, refunds propagate in seconds, and the entitlement layer runs at no cost.

## Docs

* Migrate from RevenueCat: https://superwall.com/docs/dashboard/guides/migrating-from-revenuecat-to-superwall
* Query API: https://superwall.com/docs/dashboard/guides/query-clickhouse
* Webhooks: https://superwall.com/docs/integrations/webhooks
* Pricing: https://superwall.com/pricing

# useUser

## Purpose

The `useUser` hook provides a convenient way to manage user identity and attributes, and access user-specific information like subscription status.

## Returned Values

<TypeTable
  type="{
  identify: {
    type: &#x22;(userId: string, options?: IdentifyOptions) => Promise<void>&#x22;,
    description: &#x22;Identifies the user with Superwall.&#x22;,
  },
  update: {
    type: &#x22;(attributes: Record<string, any | null> | ((old: Record<string, any | null>) => Record<string, any | null>)) => Promise<void>&#x22;,
    description: &#x22;Updates the current user's attributes.&#x22;,
  },
  signOut: {
    type: &#x22;() => void&#x22;,
    description: &#x22;Resets the user's identity and clears user-specific data.&#x22;,
  },
  refresh: {
    type: &#x22;() => Promise<Record<string, any>>&#x22;,
    description: &#x22;Refreshes user attributes and subscription status from Superwall.&#x22;,
  },
  setIntegrationAttributes: {
    type: &#x22;(attributes: IntegrationAttributes) => Promise<void>&#x22;,
    description: &#x22;Sets third-party integration identifiers (Adjust, Amplitude, AppsFlyer, Appstack, etc.).&#x22;,
  },
  getIntegrationAttributes: {
    type: &#x22;() => Promise<Record<string, string>>&#x22;,
    description: &#x22;Returns the currently set integration attributes.&#x22;,
  },
  getEntitlements: {
    type: &#x22;() => Promise<EntitlementsInfo>&#x22;,
    description: &#x22;Fetches the user's entitlement snapshot, including active and inactive entitlements, plus all known entitlements when exposed by the native bridge.&#x22;,
  },
  setSubscriptionStatus: {
    type: &#x22;(status: SubscriptionStatus) => Promise<void>&#x22;,
    description: &#x22;Manually sets the user's subscription status.&#x22;,
  },
  subscriptionStatus: {
    type: &#x22;SubscriptionStatus&#x22;,
    description: &#x22;Current subscription status for the user.&#x22;,
  },
  user: {
    type: &#x22;UserAttributes | null&#x22;,
    description: &#x22;Current user attributes. Null after signOut; undefined before initial load.&#x22;,
  },
}"
/>

### IdentifyOptions

<TypeTable
  type="{
  restorePaywallAssignments: {
    type: &#x22;boolean?&#x22;,
    description: &#x22;Restores paywall assignments from a previous session.&#x22;,
    default: &#x22;false&#x22;,
  },
}"
/>

### SubscriptionStatus

<TypeTable
  type="{
  status: {
    type: &#x22;\&#x22;UNKNOWN\&#x22; | \&#x22;INACTIVE\&#x22; | \&#x22;ACTIVE\&#x22;&#x22;,
    description: &#x22;Current subscription status value.&#x22;,
    required: true,
  },
  entitlements: {
    type: &#x22;Entitlement[]?&#x22;,
    description: &#x22;Only present when status is \&#x22;ACTIVE\&#x22;.&#x22;,
  },
}"
/>

### EntitlementsInfo

<TypeTable
  type="{
  all: {
    type: &#x22;Entitlement[]?&#x22;,
    description: &#x22;All entitlements known for the user. Present when the native bridge exposes the full entitlement set.&#x22;,
  },
  active: {
    type: &#x22;Entitlement[]&#x22;,
    description: &#x22;Entitlements that are currently active.&#x22;,
    required: true,
  },
  inactive: {
    type: &#x22;Entitlement[]&#x22;,
    description: &#x22;Entitlements that are known but not currently active.&#x22;,
    required: true,
  },
}"
/>

### UserAttributes

<TypeTable
  type="{
  aliasId: {
    type: &#x22;string&#x22;,
    description: &#x22;Alias ID for the user.&#x22;,
  },
  appUserId: {
    type: &#x22;string&#x22;,
    description: &#x22;Application-specific user ID.&#x22;,
  },
  applicationInstalledAt: {
    type: &#x22;string&#x22;,
    description: &#x22;ISO date string for when the app was installed.&#x22;,
  },
  seed: {
    type: &#x22;number&#x22;,
    description: &#x22;Seed used for experiment assignment.&#x22;,
  },
  &#x22;[key: string]&#x22;: {
    type: &#x22;any | null&#x22;,
    description: &#x22;Other custom user attributes. Values may be null.&#x22;,
  },
}"
/>

## Usage

[Managing Users](/docs/expo/guides/managing-users)