CRITICAL: introductoryPricePaymentModeIOS returns "empty" instead of "free-trial" after migration to v14

[ArekChr]

Bug Description

After migrating from react-native-iap versions 12/13 to version 14, the introductoryPricePaymentModeIOS field returns "empty" instead of the expected "free-trial" value for iOS subscriptions with free trial periods, which prevents the production app from correctly identifying which subscriptions have free trial periods.

Environment

• react-native-iap version: 14.4.23 (migrated from v13
• Platform: iOS
• React Native version: 0.81.4

Expected vs Actual Behavior

Expected:

"introductoryPricePaymentModeIOS": "free-trial"

Actual (after migration):

"introductoryPricePaymentModeIOS": "empty"

jsonRepresentationIOS field:

{"attributes":{"description":{"standard":"Essential"},"editorialArtwork":{},"icuLocale":"pl_PL@currency=PLN","isFamilyShareable":0,"isMerchandisedEnabled":0,"isMerchandisedVisibleByDefault":0,"isSubscription":1,"kind":"Auto-Renewable Subscription","name":"SmartWorkout Coach Essential","offerName":"com.arkadiuszchr.SmartWorkout.coach.essential.monthly","offers":[{"assets":[],"buyParams":"productType=A&price=39990&salableAdamId=6479899453&pricingParameters=STDQ&pg=bruno_pln&offerName=com.arkadiuszchr.SmartWorkout.coach.essential.monthly&appAdamId=1510802814","currencyCode":"PLN","discounts":[{"modeType":"FreeTrial","numOfPeriods":1,"price":0,"priceFormatted":"0,00 zł","priceString":"0","recurringSubscriptionPeriod":"P1M","type":"IntroOffer"}],"price":39.99,"priceFormatted":"39,99 zł","priceString":"39.99","recurringSubscriptionPeriod":"P1M","type":"buy"}],"releaseDate":"2009-06-17","subscriptionFamilyId":"20857400","subscriptionFamilyName":"Subscription","subscriptionFamilyRank":6,"supportsRuntimePricing":0,"url":"https://sandbox.itunes.apple.com/pl/app/smartworkout-coach-essential/id1510802814?l=pl"},"href":"/v1/catalog/pl/in-apps/6479899453?l=pl","id":"6479899453","type":"in-apps"}

[hyochan]

Problem

introductoryPricePaymentModeIOS was returning "empty" instead of "free-trial" for subscriptions with introductory offers.

Root Cause

The field was not being set when subscription.introductoryOffer was nil, even though introductory offer information existed in the discountsIOS array. This caused the field to be omitted during JSON serialization, which then got normalized to "empty" in TypeScript.

Fix

Added fallback logic in StoreKitTypesBridge.swift:

1. First attempts to use subscription.introductoryOffer?.paymentMode
2. If nil, extracts payment mode from the first introductory discount in discountsIOS array
3. Ensures the field is always properly populated when introductory offers exist

Result: Now correctly returns "free-trial" ✅

[ArekChr]

@hyochan I've upgraded react-native-iap to 14.4.24 and introductoryPricePaymentModeIOS still shows "empty" for free trial introductory offer

this is object im receiving

{
  "id": "com.arkadiuszchr.SmartWorkout.pro.yearly",
  "title": "SmartWorkout Pro",
  "description": "Pro",
  "type": "subs",
  "displayName": "SmartWorkout Pro",
  "displayPrice": "159,99 zł",
  "currency": "PLN",
  "price": 159.99,
  "debugDescription": null,
  "platform": "ios",
  "displayNameIOS": "SmartWorkout Pro",
  "isFamilyShareableIOS": false,
  "typeIOS": "auto-renewable-subscription",
  "introductoryPriceAsAmountIOS": "0",
  "introductoryPriceIOS": "0,00 zł",
  "introductoryPriceNumberOfPeriodsIOS": "2",
  "introductoryPricePaymentModeIOS": "empty",
  "introductoryPriceSubscriptionPeriodIOS": "week",
  "subscriptionPeriodNumberIOS": "1",
  "subscriptionPeriodUnitIOS": "year",
  "discountsIOS": []
}

jsonRepresentationIOS shows FreeTrial in modeType

{
  "attributes": {
    "description": {
      "standard": "Pro"
    },
    "editorialArtwork": {},
    "icuLocale": "pl_PL@currency=PLN",
    "isFamilyShareable": 0,
    "isMerchandisedEnabled": 0,
    "isMerchandisedVisibleByDefault": 0,
    "isSubscription": 1,
    "kind": "Auto-Renewable Subscription",
    "name": "SmartWorkout Pro",
    "offerName": "com.arkadiuszchr.SmartWorkout.pro.yearly",
    "offers": [
      {
        "assets": [],
        "buyParams": "productType=A&price=159990&salableAdamId=1578674504&pricingParameters=STDQ&pg=bruno_pln&offerName=com.arkadiuszchr.SmartWorkout.pro.yearly&appAdamId=1510802814",
        "currencyCode": "PLN",
        "discounts": [
          {
            "modeType": "FreeTrial",
            "numOfPeriods": 1,
            "price": 0,
            "priceFormatted": "0,00 zł",
            "priceString": "0",
            "recurringSubscriptionPeriod": "P14D",
            "type": "IntroOffer"
          }
        ],
        "price": 159.99,
        "priceFormatted": "159,99 zł",
        "priceString": "159.99",
        "recurringSubscriptionPeriod": "P1Y",
        "type": "buy"
      }
    ],
    "releaseDate": "2009-06-17",
    "subscriptionFamilyId": "20857400",
    "subscriptionFamilyName": "Subskrypcja",
    "subscriptionFamilyRank": 8,
    "supportsRuntimePricing": 0,
    "url": "https://sandbox.itunes.apple.com/pl/app/smartworkout-pro/id1510802814?l=pl"
  },
  "href": "/v1/catalog/pl/in-apps/1578674504?l=pl",
  "id": "1578674504",
  "type": "in-apps"
}

[ArekChr]

Thank you 🙏 waiting for release

[ArekChr]

@hyochan introductoryPricePaymentModeIOS is still parsed as "empty" for "modeType":"FreeTrial" from jsonRepresentationIOS, checked with "react-native-iap": "14.4.25", Apple openiap v1.2.26 after merging this PR hyodotdev/openiap#21

[ArekChr]

@hyochan The problem appears to be in the Swift enum definitions and field mapping logic throughout the iOS bridge. After investigation, I found that multiple fields are incorrectly mapped in PaymentModeIOS enum definition in Types.swift. The enum values need to match StoreKit 2's camelCase format:

current:

public enum PaymentModeIOS: String, Codable, CaseIterable {
    case empty = "empty"
    case freeTrial = "free-trial"
    case payAsYouGo = "pay-as-you-go"
    case payUpFront = "pay-up-front"
}

fix needed:

public enum PaymentModeIOS: String, Codable, CaseIterable {
    case empty = "empty"
    case freeTrial = "freeTrial" 
    case payAsYouGo = "payAsYouGo"  
    case payUpFront = "payUpFront"  
}

[ArekChr]

I see that all the enum values are in kebab-case format. The root cause might be occurring elsewhere during the mapping process, but when I changed my local enum to camelCase, introductoryPricePaymentModeIOS started returning the correct value 'free-trial' instead of 'empty'.

[hyochan]

@ArekChr Thanks for the clue! You were right - this was an enum mapping issue.

StoreKit sometimes returns introductoryOffer with incomplete data (e.g., paymentMode is nil/empty), but the correct data exists in jsonRepresentation. Our code wasn't handling this case properly.

Solution

Fixed in the upcoming release by:

1. Validating StoreKit data completeness - Check if paymentMode is .empty after mapping
2. JSON fallback for incomplete data - Parse from jsonRepresentation when StoreKit data is incomplete
3. Consistent enum mapping - All mappings now use enum raw values from Types.swift (no hardcoded strings)

// Now checks if StoreKit returned incomplete data
if discount.paymentMode != .empty {
    discounts.append(discount)
} else {
    // Fallback to JSON parsing
    if let introFromJSON = parseIntroductoryOfferFromJSON(product) {
        discounts.append(introFromJSON)
    }
}

This ensures introductoryPricePaymentModeIOS correctly returns "free-trial" instead of "empty" even when StoreKit has bugs.

Fixes: hyodotdev/openiap#22
Released: https://github.com/hyochan/react-native-iap/releases/tag/14.4.26

[ArekChr]

@hyochan in 14.4.26 I still see introductoryPricePaymentModeIOS: "empty"

[irekrog]

@ArekChr, try 14.4.31. I had a similar problem, and it works correctly in this version

[ArekChr]

cannot build the app, got NitroModules cannot be found! Are you sure you installed NitroModules properly?
last working version for me is 14.4.26

[hyochan]

@ArekChr Have you tried reinstalling react-native-nitro-modules and pod install?

[ArekChr]

I had to upgrade nitro-modules. After upgrading both packages, all works, thank you for your effort. I think we can close this discussion :)

[hyochan]

@ArekChr Thanks! Enjoy 🍖