iOS RenewalInfoIOS
Subscription renewal details exposed by StoreKit 2's Product.SubscriptionInfo.RenewalInfo. Carries auto-renewal intent, billing-retry state, price-increase responses, and the JWS payload for server-side verification.
iOS only. Mirrors Product.SubscriptionInfo.RenewalInfo — autoRenewStatus, renewalDate, expirationReason (Apple docs).
RenewalInfoIOS#
| Name | Summary |
|---|---|
willAutoRenew | Whether the subscription will automatically renew. |
autoRenewPreference | Product ID the subscription will renew to (may differ if an upgrade or downgrade is pending). |
expirationReason | StoreKit's raw integer expiration-reason value represented as a string. The Xcode 27 SDK adds the back-deployed unbundled case for subscriptions that leave an Apple Subscription Bundle; callers should preserve unknown future values. |
gracePeriodExpirationDate | Grace-period end timestamp (epoch ms). |
isInBillingRetry | True if Apple is retrying after a billing failure. |
pendingUpgradeProductId | Product ID for the pending upgrade/downgrade. |
priceIncreaseStatus | Price-increase response: "AGREED", "PENDING", or null. |
renewalDate | Expected renewal timestamp (epoch ms). |
renewalOfferId | Offer ID applied to the next renewal. |
renewalOfferType | Offer type: "PROMOTIONAL", "SUBSCRIPTION_OFFER_CODE", "WIN_BACK". |
renewalBillingPlanType | StoreKit 26.4 billing plan type for the next renewal when available: monthly, up-front, or unknown. |
commitmentInfo | Commitment renewal details, including auto-renew product, renewal billing plan type, renewal date, and renewal price. See RenewalCommitmentInfoIOS. |
bundleOriginalTransactionId | Original transaction ID of the Subscription Bundle or Suite used by the next renewal (Xcode 27 SDK). |
bundleProductId | Product ID of the bundle or suite used by the renewal. |
bundleSubscriptionGroupId | Subscription-group ID of the bundle or suite used by the renewal. |
willUnbundle | Whether this subscription will leave its bundle and renew as a standalone subscription. |
jsonRepresentation | Raw JWS representation of the StoreKit renewal info — useful for server-side validation. |