View.offerCodeRedemption
NewiOSmacOSnonisolated public func offerCodeRedemption(options: Set<RedeemOption>, isPresented: Binding<Bool>, onCompletion: @escaping @MainActor (Result<VerificationResult<Transaction>, any Error>) -> Void) -> some ViewPresents a sheet that enables customers to redeem offer codes that you configure in App Store Connect.
The offerCodeRedemption(options:isPresented:onCompletion:) method displays a system sheet where customers can enter and redeem offer codes. If you generate offer codes in App Store Connect, call this method to enable customers to redeem the offer. To display the sheet using UIKit, see presentOfferCodeRedeemSheet(from:options:).
Important: Set up offer codes in App Store Connect before calling this API. Customers can only redeem these offers in your app through the redemption sheet; don’t use a custom UI. For more information, see <doc://com.apple.documentation/documentation/storekit/appstore/supporting_subscription_offer_codes_in_your_app>.
The following code example shows a view that displays the offer code redemption sheet when the customer taps a button:
import SwiftUI
import StoreKit
struct ContentView: View {
@State private var redeemSheetIsPresented = false
var body: some View {
Button("Present offer code redemption sheet.") {
redeemSheetIsPresented = true
}
.offerCodeRedemption(
options: [],
isPresented: $redeemSheetIsPresented
) { result in
// Handle result
}
}
}When the customer successfully redeems an offer code, the system delivers the resulting transaction through onCompletion, as a VerificationResult that wraps the Transaction.
Parameters
options- A set of
RedeemOptionvalues that configure the code redemption. isPresented- A binding to a Boolean value that determines whether the system displays the sheet. You set the Boolean value to
trueto cause the system to display the sheet. The system sets it tofalsewhen it dismisses the sheet. onCompletion- A closure the system calls with the result of the redemption. On success, the closure receives a
VerificationResultcontaining theTransactionthat the redemption produces. On failure, it receives the error that caused the redemption to fail.