-
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 StringexpirationReasonprivate final DoublegracePeriodExpirationDateprivate final BooleanisInBillingRetryprivate final StringjsonRepresentationprivate final StringpendingUpgradeProductIdprivate final StringpriceIncreaseStatusprivate final DoublerenewalDateprivate final StringrenewalOfferIdprivate final StringrenewalOfferTypeprivate final BooleanwillAutoRenew
-
Constructor Summary
Constructors Constructor Description RenewalInfoIOS(String autoRenewPreference, String expirationReason, Double gracePeriodExpirationDate, Boolean isInBillingRetry, String jsonRepresentation, String pendingUpgradeProductId, String priceIncreaseStatus, Double renewalDate, String renewalOfferId, String renewalOfferType, Boolean willAutoRenew)
-
Method Summary
Modifier and Type Method Description final StringgetAutoRenewPreference()final StringgetExpirationReason()When subscription expires due to cancellation/billing issue Possible values: "VOLUNTARY", "BILLING_ERROR", "DID_NOT_AGREE_TO_PRICE_INCREASE", "PRODUCT_NOT_AVAILABLE", "UNKNOWN" 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 Note: Not directly available in RenewalInfo, available in Status 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 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 Map<String, Object>toJson()-
-
Constructor Detail
-
RenewalInfoIOS
RenewalInfoIOS(String autoRenewPreference, String expirationReason, Double gracePeriodExpirationDate, Boolean isInBillingRetry, String jsonRepresentation, String pendingUpgradeProductId, String priceIncreaseStatus, Double renewalDate, String renewalOfferId, String renewalOfferType, Boolean willAutoRenew)
-
-
Method Detail
-
getAutoRenewPreference
final String getAutoRenewPreference()
-
getExpirationReason
final String getExpirationReason()
When subscription expires due to cancellation/billing issue Possible values: "VOLUNTARY", "BILLING_ERROR", "DID_NOT_AGREE_TO_PRICE_INCREASE", "PRODUCT_NOT_AVAILABLE", "UNKNOWN"
-
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 Note: Not directly available in RenewalInfo, available in Status
-
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)
-
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()
-
-
-
-