API Reference

@MainActor @Observable
public class WhopIAP

static var shared: WhopIAP

import WhopPayments

@State private var iap = WhopIAP.shared

static func configure(
    companyID: String,
    productIDs: [String],
    apiKey: String
) async throws -> WhopIAP

iap = try await WhopIAP.configure(
    companyID: "biz_xxxxxxxxxxxxxx",
    productIDs: ["prod_xxxxxxxxxxxxxx"],
    apiKey: "your_api_key_here"
)

var isInitialized: Bool { get }

if iap.isInitialized {
    // SDK ready to use
}

var deviceId: String { get }

var appUserId: String? { get }

var plans: [WhopIAPPlan] { get }

ForEach(iap.plans) { plan in
    Text(plan.title ?? "Plan")
}

var memberships: [WhopIAPMembership] { get }

func hasAccess(to productId: String) -> Bool

if iap.hasAccess(to: "prod_pro_features") {
    // Show pro features
}

func purchase(_ planId: String) async throws -> PurchaseResult

do {
    let result = try await iap.purchase("plan_xxxxxxxxxxxxxx")
    print("Success! Membership: \(result.membership.id)")
} catch WhopIAPError.cancelled {
    // User cancelled
} catch {
    // Handle error
}

func logIn(appUserId: String) async throws

try await iap.logIn(appUserId: "user_123")

func logOut()

iap.logOut()

struct PurchaseResult {
    let receiptId: String
    let membership: WhopIAPMembership
}

struct WhopIAPPlan: Identifiable {
    let id: String
    let productId: String?
    let title: String?
    let planType: PlanType
    let billingPeriodDays: Int?
    let baseCurrency: String
    let initialPrice: Double
    let renewalPrice: Double
    let trialPeriodDays: Int?
}

enum PlanType: String {
    case oneTime = "one_time"
    case renewal
    case unknown
}

struct WhopIAPMembership: Identifiable {
    let id: String
    let productId: String
    let planId: String
    let status: Status
    let isClaimed: Bool
    let createdAt: Date
    let expiresAt: Date?
    let renewalPeriodEnd: Date?
    let cancelAtPeriodEnd: Bool
    let receiptId: String?
}

enum Status: String {
    case active
    case canceled
    case canceling
    case completed
    case drafted
    case expired
    case pastDue = "past_due"
    case trialing
    case unresolved
    case unknown
}

enum WhopIAPError: Error {
    case cancelled
    case tokenUnavailable
    case paymentFailed(String)
}