Types and Enums

Deprecated SDK

We strongly recommend migrating to the new Superwall Expo SDK, see our migration guide for details.

Overview

This page provides reference documentation for types, enums, and result objects used throughout the React Native SDK.

SubscriptionStatus

Represents the subscription status of a user.

type SubscriptionStatus =
  | SubscriptionStatus.Active
  | SubscriptionStatus.Inactive
  | SubscriptionStatus.Unknown

// Create instances
const active = SubscriptionStatus.Active(["pro", "premium"])
const inactive = SubscriptionStatus.Inactive()
const unknown = SubscriptionStatus.Unknown()

Active: status: "ACTIVE" and an entitlements array (string IDs or Entitlement objects)
Inactive: status: "INACTIVE"
Unknown: status: "UNKNOWN"

PaywallResult

Result of a paywall presentation.

type PaywallResult =
  | { type: "purchased"; productId: string }
  | { type: "declined" }
  | { type: "restored" }

purchased: User successfully purchased (includes productId)
declined: User dismissed/declined the paywall
restored: User restored a previous purchase

PresentationResult

Result of checking whether a placement will present a paywall.

type PresentationResult =
  | PresentationResultPaywall      // contains an Experiment
  | PresentationResultHoldout      // contains an Experiment
  | PresentationResultNoAudienceMatch
  | PresentationResultPlacementNotFound
  | PresentationResultUserIsSubscribed
  | PresentationResultPaywallNotAvailable

Use PresentationResult.fromJson(...) to materialize instances returned from the native bridge.
Holdout/Paywall results include the associated Experiment.

TriggerResult

Result of registering a placement.

enum TriggerResultType {
  placementNotFound,
  noAudienceMatch,
  paywall,
  holdout,
  error,
}

class TriggerResult {
  type: TriggerResultType
  experiment?: Experiment
  error?: string
}

Use TriggerResult.fromJson(...) to parse responses.

ConfigurationStatus

Status of SDK configuration.

enum ConfigurationStatus {
  PENDING = "PENDING",
  CONFIGURED = "CONFIGURED",
  FAILED = "FAILED"
}

PENDING: Configuration is in progress
CONFIGURED: Configuration completed successfully
FAILED: Configuration failed

EntitlementsInfo

Information about user entitlements.

interface EntitlementsInfo {
  status: SubscriptionStatus
  active: Entitlement[]
  all: Entitlement[]
  inactive: Entitlement[]
}

PaywallInfo

Information about a paywall.

interface PaywallInfo {
  identifier: string
  name: string
  url: string
  experiment?: Experiment
  products: Product[]
  productIds: string[]
  // ...additional timing and metadata fields
}

PaywallSkippedReason

Reason why a paywall was skipped.

type PaywallSkippedReason =
  | PaywallSkippedReasonHoldout    // includes Experiment
  | PaywallSkippedReasonNoAudienceMatch
  | PaywallSkippedReasonPlacementNotFound
  | PaywallSkippedReasonUserIsSubscribed

Holdout and paywall decisions include the associated Experiment instance.

PurchaseResult

Result of a purchase attempt.

class PurchaseResult { type: string; error?: string }
class PurchaseResultPurchased extends PurchaseResult {}
class PurchaseResultCancelled extends PurchaseResult {}
class PurchaseResultFailed extends PurchaseResult { error: string }
class PurchaseResultPending extends PurchaseResult {}

RestorationResult

Result of a restore purchases attempt.

abstract class RestorationResult {
  static restored(): RestorationResult
  static failed(error?: Error): RestorationResult
}

RestorationResult.restored() when purchases are restored
RestorationResult.failed(error?) when restoration fails

RedemptionResults

Result of redeeming a promotional link.

type RedemptionResult =
  | { status: "SUCCESS"; code: string; redemptionInfo: RedemptionInfo }
  | { status: "ERROR"; code: string; error: { message: string } }
  | { status: "CODE_EXPIRED"; code: string; expired: { resent: boolean; obfuscatedEmail?: string } }
  | { status: "INVALID_CODE"; code: string }
  | { status: "EXPIRED_SUBSCRIPTION"; code: string; redemptionInfo: RedemptionInfo }

LogLevel

Logging level.

enum LogLevel {
  Debug = "debug",
  Info = "info",
  Warn = "warn",
  Error = "error",
  None = "none"
}

LogScope

Logging scope.

enum LogScope {
  LocalizationManager = "localizationManager",
  BounceButton = "bounceButton",
  CoreData = "coreData",
  ConfigManager = "configManager",
  IdentityManager = "identityManager",
  DebugManager = "debugManager",
  DebugViewController = "debugViewController",
  LocalizationViewController = "localizationViewController",
  GameControllerManager = "gameControllerManager",
  Device = "device",
  Network = "network",
  PaywallEvents = "paywallEvents",
  ProductsManager = "productsManager",
  StoreKitManager = "storeKitManager",
  Placements = "placements",
  Receipts = "receipts",
  SuperwallCore = "superwallCore",
  PaywallPresentation = "paywallPresentation",
  PaywallTransactions = "paywallTransactions",
  PaywallViewController = "paywallViewController",
  Cache = "cache",
  All = "all",
}

InterfaceStyle

Interface style preference.

enum InterfaceStyle {
  LIGHT = "LIGHT",
  DARK = "DARK"
}

NetworkEnvironment

Network environment.

enum NetworkEnvironment {
  Release = "release",
  ReleaseCandidate = "releaseCandidate",
  Developer = "developer"
}

TransactionBackgroundView

View to show behind Apple's payment sheet.

enum TransactionBackgroundView {
  spinner = "spinner",
  none = "none"
}

SubscriptionStatus methods - Getting and setting subscription status
PaywallResult usage - Handling paywall results

Types and Enums

On this page