Package com.apple.itunes.storekit.model

Class JWSRenewalInfoDecodedPayload

java.lang.Object
com.apple.itunes.storekit.model.JWSRenewalInfoDecodedPayload
All Implemented Interfaces:
DecodedSignedData
public class JWSRenewalInfoDecodedPayload extends Object implements DecodedSignedData
A decoded payload containing subscription renewal information for an auto-renewable subscription.
See Also:

  • Constructor Details

    • JWSRenewalInfoDecodedPayload

      public JWSRenewalInfoDecodedPayload()

  • Method Details

    • expirationIntent

      public JWSRenewalInfoDecodedPayload expirationIntent(ExpirationIntent expirationIntent)

    • getExpirationIntent

      public ExpirationIntent getExpirationIntent()
      The reason the subscription expired.
      Returns:
      expirationIntent
      See Also:

    • getRawExpirationIntent

      public Integer getRawExpirationIntent()
      See Also:

    • setExpirationIntent

      public void setExpirationIntent(ExpirationIntent expirationIntent)

    • setRawExpirationIntent

      public void setRawExpirationIntent(Integer rawExpirationIntent)

    • originalTransactionId

      public JWSRenewalInfoDecodedPayload originalTransactionId(String originalTransactionId)

    • getOriginalTransactionId

      public String getOriginalTransactionId()
      The original transaction identifier of a purchase.
      Returns:
      originalTransactionId
      See Also:

    • setOriginalTransactionId

      public void setOriginalTransactionId(String originalTransactionId)

    • autoRenewProductId

      public JWSRenewalInfoDecodedPayload autoRenewProductId(String autoRenewProductId)

    • getAutoRenewProductId

      public String getAutoRenewProductId()
      The product identifier of the product that will renew at the next billing period.
      Returns:
      autoRenewProductId
      See Also:

    • setAutoRenewProductId

      public void setAutoRenewProductId(String autoRenewProductId)

    • productId

      public JWSRenewalInfoDecodedPayload productId(String productId)

    • getProductId

      public String getProductId()
      The unique identifier for the product, that you create in App Store Connect.
      Returns:
      productId
      See Also:

    • setProductId

      public void setProductId(String productId)

    • autoRenewStatus

      public JWSRenewalInfoDecodedPayload autoRenewStatus(AutoRenewStatus autoRenewStatus)

    • getAutoRenewStatus

      public AutoRenewStatus getAutoRenewStatus()
      The renewal status of the auto-renewable subscription.
      Returns:
      autoRenewStatus
      See Also:

    • getRawAutoRenewStatus

      public Integer getRawAutoRenewStatus()
      See Also:

    • setAutoRenewStatus

      public void setAutoRenewStatus(AutoRenewStatus autoRenewStatus)

    • setRawAutoRenewStatus

      public void setRawAutoRenewStatus(Integer rawAutoRenewStatus)

    • isInBillingRetryPeriod

      public JWSRenewalInfoDecodedPayload isInBillingRetryPeriod(Boolean isInBillingRetryPeriod)

    • getIsInBillingRetryPeriod

      public Boolean getIsInBillingRetryPeriod()
      A Boolean value that indicates whether the App Store is attempting to automatically renew an expired subscription.
      Returns:
      isInBillingRetryPeriod
      See Also:

    • setIsInBillingRetryPeriod

      public void setIsInBillingRetryPeriod(Boolean isInBillingRetryPeriod)

    • priceIncreaseStatus

      public JWSRenewalInfoDecodedPayload priceIncreaseStatus(PriceIncreaseStatus priceIncreaseStatus)

    • getPriceIncreaseStatus

      public PriceIncreaseStatus getPriceIncreaseStatus()
      The status that indicates whether the auto-renewable subscription is subject to a price increase.
      Returns:
      priceIncreaseStatus
      See Also:

    • getRawPriceIncreaseStatus

      public Integer getRawPriceIncreaseStatus()
      See Also:

    • setPriceIncreaseStatus

      public void setPriceIncreaseStatus(PriceIncreaseStatus priceIncreaseStatus)

    • setRawPriceIncreaseStatus

      public void setRawPriceIncreaseStatus(Integer rawPriceIncreaseStatus)

    • gracePeriodExpiresDate

      public JWSRenewalInfoDecodedPayload gracePeriodExpiresDate(Long gracePeriodExpiresDate)

    • getGracePeriodExpiresDate

      public Long getGracePeriodExpiresDate()
      The time when the billing grace period for subscription renewals expires.
      Returns:
      gracePeriodExpiresDate
      See Also:

    • setGracePeriodExpiresDate

      public void setGracePeriodExpiresDate(Long gracePeriodExpiresDate)

    • offerType

      public JWSRenewalInfoDecodedPayload offerType(OfferType offerType)

    • getOfferType

      public OfferType getOfferType()
      The type of the subscription offer.
      Returns:
      offerType
      See Also:

    • getRawOfferType

      public Integer getRawOfferType()
      See Also:

    • setOfferType

      public void setOfferType(OfferType offerType)

    • setRawOfferType

      public void setRawOfferType(Integer rawOfferType)

    • offerIdentifier

      public JWSRenewalInfoDecodedPayload offerIdentifier(String offerIdentifier)

    • getOfferIdentifier

      public String getOfferIdentifier()
      The identifier that contains the promo code or the promotional offer identifier.
      Returns:
      offerIdentifier
      See Also:

    • setOfferIdentifier

      public void setOfferIdentifier(String offerIdentifier)

    • signedDate

      public JWSRenewalInfoDecodedPayload signedDate(Long signedDate)

    • getSignedDate

      public Long getSignedDate()
      The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
      Specified by:
      getSignedDate in interface DecodedSignedData
      Returns:
      signedDate
      See Also:

    • setSignedDate

      public void setSignedDate(Long signedDate)

    • environment

      public JWSRenewalInfoDecodedPayload environment(Environment environment)

    • getEnvironment

      public Environment getEnvironment()
      The server environment, either sandbox or production.
      Returns:
      environment
      See Also:

    • getRawEnvironment

      public String getRawEnvironment()
      See Also:

    • setEnvironment

      public void setEnvironment(Environment environment)

    • setRawEnvironment

      public void setRawEnvironment(String rawEnvironment)

    • recentSubscriptionStartDate

      public JWSRenewalInfoDecodedPayload recentSubscriptionStartDate(Long recentSubscriptionStartDate)

    • getRecentSubscriptionStartDate

      public Long getRecentSubscriptionStartDate()
      The earliest start date of a subscription in a series of auto-renewable subscription purchases that ignores all lapses of paid service shorter than 60 days.
      Returns:
      recentSubscriptionStartDate
      See Also:

    • setRecentSubscriptionStartDate

      public void setRecentSubscriptionStartDate(Long recentSubscriptionStartDate)

    • renewalDate

      public JWSRenewalInfoDecodedPayload renewalDate(Long renewalDate)

    • getRenewalDate

      public Long getRenewalDate()
      The UNIX time, in milliseconds, when the most recent auto-renewable subscription purchase expires.
      Returns:
      renewalDate
      See Also:

    • setRenewalDate

      public void setRenewalDate(Long renewalDate)

    • renewalPrice

      public JWSRenewalInfoDecodedPayload renewalPrice(Long renewalPrice)

    • getRenewalPrice

      public Long getRenewalPrice()
      The renewal price, in milliunits, of the auto-renewable subscription that renews at the next billing period.
      Returns:
      renewalPrice
      See Also:

    • setRenewalPrice

      public void setRenewalPrice(Long renewalPrice)

    • currency

      public JWSRenewalInfoDecodedPayload currency(String currency)

    • getCurrency

      public String getCurrency()
      The currency code for the renewalPrice of the subscription.
      Returns:
      currency
      See Also:

    • setCurrency

      public void setCurrency(String currency)

    • offerDiscountType

      public JWSRenewalInfoDecodedPayload offerDiscountType(OfferDiscountType offerDiscountType)

    • getOfferDiscountType

      public OfferDiscountType getOfferDiscountType()
      The payment mode of the discount offer.
      Returns:
      offerDiscountType
      See Also:

    • getRawOfferDiscountType

      public String getRawOfferDiscountType()
      See Also:

    • setOfferDiscountType

      public void setOfferDiscountType(OfferDiscountType offerDiscountType)

    • setRawOfferDiscountType

      public void setRawOfferDiscountType(String rawOfferDiscountType)

    • eligibleWinBackOfferIds

      public JWSRenewalInfoDecodedPayload eligibleWinBackOfferIds(List<String> eligibleWinBackOfferIds)

    • addEligibleWinBackOfferId

      public JWSRenewalInfoDecodedPayload addEligibleWinBackOfferId(String eligibleWinBackOfferId)

    • getEligibleWinBackOfferIds

      public List<String> getEligibleWinBackOfferIds()
      An array of win-back offer identifiers that a customer is eligible to redeem, which sorts the identifiers to present the better offers first.
      Returns:
      eligibleWinBackOfferIds
      See Also:

    • setEligibleWinBackOfferIds

      public void setEligibleWinBackOfferIds(List<String> eligibleWinBackOfferIds)

    • unknownFields

      public JWSRenewalInfoDecodedPayload unknownFields(Map<String,Object> unknownFields)

    • getUnknownFields

      public Map<String,Object> getUnknownFields()
      Fields that are not recognized for this object
      Returns:
      A map of JSON keys to objects

    • setUnknownFields

      public void setUnknownFields(Map<String,Object> unknownFields)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object