-
public final class RenewalInfoIOSSubscription renewal information from Product.SubscriptionInfo.RenewalInfo https://developer.apple.com/documentation/storekit/product/subscriptioninfo/renewalinfo
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classRenewalInfoIOS.Companion
-
Field Summary
Fields Modifier and Type Field Description private final StringautoRenewPreferenceprivate final StringbundleOriginalTransactionIdprivate final StringbundleProductIdprivate final StringbundleSubscriptionGroupIdprivate final RenewalCommitmentInfoIOScommitmentInfoprivate final StringexpirationReasonprivate final DoublegracePeriodExpirationDateprivate final BooleanisInBillingRetryprivate final StringjsonRepresentationprivate final StringpendingUpgradeProductIdprivate final StringpriceIncreaseStatusprivate final SubscriptionBillingPlanTypeIOSrenewalBillingPlanTypeprivate final DoublerenewalDateprivate final StringrenewalOfferIdprivate final StringrenewalOfferTypeprivate final BooleanwillAutoRenewprivate final BooleanwillUnbundle
-
Constructor Summary
Constructors Constructor Description RenewalInfoIOS(String autoRenewPreference, String bundleOriginalTransactionId, String bundleProductId, String bundleSubscriptionGroupId, RenewalCommitmentInfoIOS commitmentInfo, String expirationReason, Double gracePeriodExpirationDate, Boolean isInBillingRetry, String jsonRepresentation, String pendingUpgradeProductId, String priceIncreaseStatus, SubscriptionBillingPlanTypeIOS renewalBillingPlanType, Double renewalDate, String renewalOfferId, String renewalOfferType, Boolean willAutoRenew, Boolean willUnbundle)
-
Method Summary
Modifier and Type Method Description final StringgetAutoRenewPreference()final StringgetBundleOriginalTransactionId()Original transaction identifier for the bundle used by the next renewal. final StringgetBundleProductId()Product identifier for the bundle used by the next renewal. final StringgetBundleSubscriptionGroupId()Subscription-group identifier for the bundle used by the next renewal. final RenewalCommitmentInfoIOSgetCommitmentInfo()iOS 26.4+ renewal commitment metadata for monthly subscriptions with a 12-month commitment. final StringgetExpirationReason()StoreKit's raw integer expiration-reason value represented as a string. final DoublegetGracePeriodExpirationDate()Grace period expiration date (milliseconds since epoch) When set, subscription is in grace period (billing issue but still has access) final BooleangetIsInBillingRetry()True if subscription failed to renew due to billing issue and is retrying StoreKit exposes this directly as RenewalInfo.isInBillingRetry. final StringgetJsonRepresentation()final StringgetPendingUpgradeProductId()Product ID that will be used on next renewal (when user upgrades/downgrades) If set and different from current productId, subscription will change on expiration final StringgetPriceIncreaseStatus()User's response to subscription price increase Possible values: "AGREED", "PENDING", null (no price increase) final SubscriptionBillingPlanTypeIOSgetRenewalBillingPlanType()iOS 26.4+ billing plan that will renew after the current period. final DoublegetRenewalDate()Expected renewal date (milliseconds since epoch) For active subscriptions, when the next renewal/charge will occur final StringgetRenewalOfferId()Offer ID applied to next renewal (promotional offer, subscription offer code, etc. final StringgetRenewalOfferType()Type of offer applied to next renewal Possible values: "PROMOTIONAL", "SUBSCRIPTION_OFFER_CODE", "WIN_BACK", etc. final BooleangetWillAutoRenew()final BooleangetWillUnbundle()Whether this subscription will leave its bundle and renew standalone. final Map<String, Object>toJson()-
-
Constructor Detail
-
RenewalInfoIOS
RenewalInfoIOS(String autoRenewPreference, String bundleOriginalTransactionId, String bundleProductId, String bundleSubscriptionGroupId, RenewalCommitmentInfoIOS commitmentInfo, String expirationReason, Double gracePeriodExpirationDate, Boolean isInBillingRetry, String jsonRepresentation, String pendingUpgradeProductId, String priceIncreaseStatus, SubscriptionBillingPlanTypeIOS renewalBillingPlanType, Double renewalDate, String renewalOfferId, String renewalOfferType, Boolean willAutoRenew, Boolean willUnbundle)
-
-
Method Detail
-
getAutoRenewPreference
final String getAutoRenewPreference()
-
getBundleOriginalTransactionId
final String getBundleOriginalTransactionId()
Original transaction identifier for the bundle used by the next renewal.
-
getBundleProductId
final String getBundleProductId()
Product identifier for the bundle used by the next renewal.
-
getBundleSubscriptionGroupId
final String getBundleSubscriptionGroupId()
Subscription-group identifier for the bundle used by the next renewal.
-
getCommitmentInfo
final RenewalCommitmentInfoIOS getCommitmentInfo()
iOS 26.4+ renewal commitment metadata for monthly subscriptions with a 12-month commitment.
-
getExpirationReason
final String getExpirationReason()
StoreKit's raw integer expiration-reason value represented as a string. Xcode 27 adds the back-deployed unbundled case. Preserve unknown future values.
-
getGracePeriodExpirationDate
final Double getGracePeriodExpirationDate()
Grace period expiration date (milliseconds since epoch) When set, subscription is in grace period (billing issue but still has access)
-
getIsInBillingRetry
final Boolean getIsInBillingRetry()
True if subscription failed to renew due to billing issue and is retrying StoreKit exposes this directly as RenewalInfo.isInBillingRetry.
-
getJsonRepresentation
final String getJsonRepresentation()
-
getPendingUpgradeProductId
final String getPendingUpgradeProductId()
Product ID that will be used on next renewal (when user upgrades/downgrades) If set and different from current productId, subscription will change on expiration
-
getPriceIncreaseStatus
final String getPriceIncreaseStatus()
User's response to subscription price increase Possible values: "AGREED", "PENDING", null (no price increase)
-
getRenewalBillingPlanType
final SubscriptionBillingPlanTypeIOS getRenewalBillingPlanType()
iOS 26.4+ billing plan that will renew after the current period.
-
getRenewalDate
final Double getRenewalDate()
Expected renewal date (milliseconds since epoch) For active subscriptions, when the next renewal/charge will occur
-
getRenewalOfferId
final String getRenewalOfferId()
Offer ID applied to next renewal (promotional offer, subscription offer code, etc.)
-
getRenewalOfferType
final String getRenewalOfferType()
Type of offer applied to next renewal Possible values: "PROMOTIONAL", "SUBSCRIPTION_OFFER_CODE", "WIN_BACK", etc.
-
getWillAutoRenew
final Boolean getWillAutoRenew()
-
getWillUnbundle
final Boolean getWillUnbundle()
Whether this subscription will leave its bundle and renew standalone.
-
-
-
-