Consumable Products
Set up consumable products for Superwall paywalls on iOS.
Use consumable products when a purchase should grant a quantity that can be used up, such as credits, coins, boosts, or tokens.
This guide assumes purchases are made from Superwall paywalls and that you are not using a PurchaseController.
Consumable products are one-time purchases that users can buy repeatedly, such as credits, tokens, boosts, or packs. Non-consumable products are also one-time purchases, but they grant permanent access, such as a lifetime unlock.
Superwall uses entitlements to decide whether a user has ongoing access. Because consumables are meant to be used up, they should usually not grant entitlements. Your app should listen for the purchase, grant the consumable benefit in your own system, and treat Superwall's purchase history as a record of what happened.
Dashboard Setup
- Create the consumable in App Store Connect.
- Add the product in Superwall from Products.
- Use the App Store product identifier.
- Set Period to None (Lifetime / Consumable).
- Leave Entitlements empty.
- Add the product to any paywall that should sell it.
Do not attach an entitlement to a consumable unless the purchase should also unlock ongoing access. If a consumable has no entitlement, buying it does not make the user's subscription status active.
Include Consumables In Purchase History
Apple excludes consumable purchases from App Store purchase history unless you opt in. Add SKIncludeConsumableInAppPurchaseHistory to your app's Info.plist as a Boolean set to YES.
<key>SKIncludeConsumableInAppPurchaseHistory</key>
<true/>When this key is present and set to YES, Superwall uses StoreKit 2 on iOS 18 and later. On earlier iOS versions, the SDK falls back to StoreKit 1 for purchase history support.
Grant The Consumable Benefit
Superwall does not maintain balances for consumables. Grant credits, tokens, or other benefits from your app or backend after the transactionComplete event. Make this operation idempotent so retries do not double-credit the user.
import SuperwallKit
final class SWDelegate: SuperwallDelegate {
func handleSuperwallEvent(withInfo eventInfo: SuperwallEventInfo) {
guard case let .transactionComplete(transaction, product, _, _) = eventInfo.event else {
return
}
guard product.productIdentifier == "com.example.credits_100" else {
return
}
Task {
await ConsumablesService.shared.grantCredits(
count: 100,
productId: product.productIdentifier,
transactionId: transaction?.storeTransactionId
)
}
}
}
Superwall.shared.delegate = SWDelegate()#import <SuperwallKit/SuperwallKit-Swift.h>
@interface SWDelegate : NSObject <SWKSuperwallDelegate>
@end
@implementation SWDelegate
- (void)handleSuperwallEventWithInfo:(SWKSuperwallEventInfo *)eventInfo {
if (eventInfo.event != SWKSuperwallEventTransactionComplete) {
return;
}
NSString *productId = eventInfo.params[@"primary_product_id"];
if (![productId isEqualToString:@"com.example.credits_100"]) {
return;
}
NSString *transactionId = eventInfo.params[@"store_transaction_id"];
[[ConsumablesService shared] grantCredits:100
productId:productId
transactionId:transactionId];
}
@end
[Superwall sharedInstance].delegate = [SWDelegate new];Read Purchase History
Consumable and non-consumable purchases appear in customerInfo.nonSubscriptions. Use isConsumable to distinguish consumables from lifetime purchases.
let customerInfo = Superwall.shared.customerInfo
let consumables = customerInfo.nonSubscriptions.filter { $0.isConsumable }
for purchase in consumables {
print("Consumable purchased: \(purchase.productId)")
}SWKCustomerInfo *customerInfo = [Superwall sharedInstance].customerInfo;
for (SWKNonSubscriptionTransaction *purchase in customerInfo.nonSubscriptions) {
if (purchase.isConsumable) {
NSLog(@"Consumable purchased: %@", purchase.productId);
}
}How is this guide?