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:

• JWSRenewalInfoDecodedPayload

Constructor Summary

Constructors

Constructor	Description
JWSRenewalInfoDecodedPayload()

Method Summary

Modifier and Type	Method	Description
JWSRenewalInfoDecodedPayload	addEligibleWinBackOfferId(String eligibleWinBackOfferId)
JWSRenewalInfoDecodedPayload	advancedCommerceInfo(AdvancedCommerceRenewalInfo advancedCommerceInfo)
JWSRenewalInfoDecodedPayload	appAccountToken(UUID appAccountToken)
JWSRenewalInfoDecodedPayload	appTransactionId(String appTransactionId)
JWSRenewalInfoDecodedPayload	autoRenewProductId(String autoRenewProductId)
JWSRenewalInfoDecodedPayload	autoRenewStatus(AutoRenewStatus autoRenewStatus)
JWSRenewalInfoDecodedPayload	commitmentInfo(RenewalCommitmentInfo commitmentInfo)
JWSRenewalInfoDecodedPayload	currency(String currency)
JWSRenewalInfoDecodedPayload	eligibleWinBackOfferIds(List<String> eligibleWinBackOfferIds)
JWSRenewalInfoDecodedPayload	environment(Environment environment)
boolean	equals(Object o)
JWSRenewalInfoDecodedPayload	expirationIntent(ExpirationIntent expirationIntent)
AdvancedCommerceRenewalInfo	getAdvancedCommerceInfo()	Renewal information that is present only for Advanced Commerce SKUs.
UUID	getAppAccountToken()	The UUID that an app optionally generates to map a customer’s In-App Purchase with its resulting App Store transaction.
String	getAppTransactionId()	The unique identifier of the app download transaction.
String	getAutoRenewProductId()	The product identifier of the product that will renew at the next billing period.
AutoRenewStatus	getAutoRenewStatus()	The renewal status of the auto-renewable subscription.
RenewalCommitmentInfo	getCommitmentInfo()
String	getCurrency()	The currency code for the renewalPrice of the subscription.
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.
Environment	getEnvironment()	The server environment, either sandbox or production.
ExpirationIntent	getExpirationIntent()	The reason the subscription expired.
Long	getGracePeriodExpiresDate()	The time when the billing grace period for subscription renewals expires.
Boolean	getIsInBillingRetryPeriod()	A Boolean value that indicates whether the App Store is attempting to automatically renew an expired subscription.
OfferDiscountType	getOfferDiscountType()	The payment mode you configure for the offer.
String	getOfferIdentifier()	The offer code or the promotional offer identifier.
String	getOfferPeriod()	The duration of the offer.
OfferType	getOfferType()	The type of subscription offer.
String	getOriginalTransactionId()	The original transaction identifier of a purchase.
PriceIncreaseStatus	getPriceIncreaseStatus()	The status that indicates whether the auto-renewable subscription is subject to a price increase.
String	getProductId()	The unique identifier for the product, that you create in App Store Connect.
Integer	getRawAutoRenewStatus()
String	getRawEnvironment()
Integer	getRawExpirationIntent()
String	getRawOfferDiscountType()
Integer	getRawOfferType()
Integer	getRawPriceIncreaseStatus()
String	getRawRenewalBillingPlanType()
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.
RenewalBillingPlanType	getRenewalBillingPlanType()
Long	getRenewalDate()	The UNIX time, in milliseconds, when the most recent auto-renewable subscription purchase expires.
Long	getRenewalPrice()	The renewal price, in milliunits, of the auto-renewable subscription that renews at the next billing period.
Long	getSignedDate()	The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.
Map<String,Object>	getUnknownFields()	Fields that are not recognized for this object
JWSRenewalInfoDecodedPayload	gracePeriodExpiresDate(Long gracePeriodExpiresDate)
int	hashCode()
JWSRenewalInfoDecodedPayload	isInBillingRetryPeriod(Boolean isInBillingRetryPeriod)
JWSRenewalInfoDecodedPayload	offerDiscountType(OfferDiscountType offerDiscountType)
JWSRenewalInfoDecodedPayload	offerIdentifier(String offerIdentifier)
JWSRenewalInfoDecodedPayload	offerPeriod(String offerPeriod)
JWSRenewalInfoDecodedPayload	offerType(OfferType offerType)
JWSRenewalInfoDecodedPayload	originalTransactionId(String originalTransactionId)
JWSRenewalInfoDecodedPayload	priceIncreaseStatus(PriceIncreaseStatus priceIncreaseStatus)
JWSRenewalInfoDecodedPayload	productId(String productId)
JWSRenewalInfoDecodedPayload	recentSubscriptionStartDate(Long recentSubscriptionStartDate)
JWSRenewalInfoDecodedPayload	renewalBillingPlanType(RenewalBillingPlanType renewalBillingPlanType)
JWSRenewalInfoDecodedPayload	renewalDate(Long renewalDate)
JWSRenewalInfoDecodedPayload	renewalPrice(Long renewalPrice)
void	setAdvancedCommerceInfo(AdvancedCommerceRenewalInfo advancedCommerceInfo)
void	setAppAccountToken(UUID appAccountToken)
void	setAppTransactionId(String appTransactionId)
void	setAutoRenewProductId(String autoRenewProductId)
void	setAutoRenewStatus(AutoRenewStatus autoRenewStatus)
void	setCommitmentInfo(RenewalCommitmentInfo commitmentInfo)
void	setCurrency(String currency)
void	setEligibleWinBackOfferIds(List<String> eligibleWinBackOfferIds)
void	setEnvironment(Environment environment)
void	setExpirationIntent(ExpirationIntent expirationIntent)
void	setGracePeriodExpiresDate(Long gracePeriodExpiresDate)
void	setIsInBillingRetryPeriod(Boolean isInBillingRetryPeriod)
void	setOfferDiscountType(OfferDiscountType offerDiscountType)
void	setOfferIdentifier(String offerIdentifier)
void	setOfferPeriod(String offerPeriod)
void	setOfferType(OfferType offerType)
void	setOriginalTransactionId(String originalTransactionId)
void	setPriceIncreaseStatus(PriceIncreaseStatus priceIncreaseStatus)
void	setProductId(String productId)
void	setRawAutoRenewStatus(Integer rawAutoRenewStatus)
void	setRawEnvironment(String rawEnvironment)
void	setRawExpirationIntent(Integer rawExpirationIntent)
void	setRawOfferDiscountType(String rawOfferDiscountType)
void	setRawOfferType(Integer rawOfferType)
void	setRawPriceIncreaseStatus(Integer rawPriceIncreaseStatus)
void	setRawRenewalBillingPlanType(String rawRenewalBillingPlanType)
void	setRecentSubscriptionStartDate(Long recentSubscriptionStartDate)
void	setRenewalBillingPlanType(RenewalBillingPlanType renewalBillingPlanType)
void	setRenewalDate(Long renewalDate)
void	setRenewalPrice(Long renewalPrice)
void	setSignedDate(Long signedDate)
void	setUnknownFields(Map<String,Object> unknownFields)
JWSRenewalInfoDecodedPayload	signedDate(Long signedDate)
String	toString()
JWSRenewalInfoDecodedPayload	unknownFields(Map<String,Object> unknownFields)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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:

• expirationIntent

getRawExpirationIntent

public Integer getRawExpirationIntent()

See Also:

• getExpirationIntent()

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:

• originalTransactionId

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:

• autoRenewProductId

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:

• productId

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:

• autoRenewStatus

getRawAutoRenewStatus

public Integer getRawAutoRenewStatus()

See Also:

• getAutoRenewStatus()

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:

• isInBillingRetryPeriod

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:

• priceIncreaseStatus

getRawPriceIncreaseStatus

public Integer getRawPriceIncreaseStatus()

See Also:

• getPriceIncreaseStatus()

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:

• gracePeriodExpiresDate

setGracePeriodExpiresDate

public void setGracePeriodExpiresDate(Long gracePeriodExpiresDate)

offerType

public JWSRenewalInfoDecodedPayload offerType(OfferType offerType)

getOfferType

public OfferType getOfferType()

The type of subscription offer.

Returns:

offerType

See Also:

• offerType

getRawOfferType

public Integer getRawOfferType()

See Also:

• getOfferType()

setOfferType

public void setOfferType(OfferType offerType)

setRawOfferType

public void setRawOfferType(Integer rawOfferType)

offerIdentifier

public JWSRenewalInfoDecodedPayload offerIdentifier(String offerIdentifier)

getOfferIdentifier

public String getOfferIdentifier()

The offer code or the promotional offer identifier.

Returns:

offerIdentifier

See Also:

• offerIdentifier

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:

• signedDate

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:

• environment

getRawEnvironment

public String getRawEnvironment()

See Also:

• getEnvironment()

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:

• recentSubscriptionStartDate

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:

• renewalDate

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:

• renewalPrice

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:

• currency

setCurrency

public void setCurrency(String currency)

offerDiscountType

public JWSRenewalInfoDecodedPayload offerDiscountType(OfferDiscountType offerDiscountType)

getOfferDiscountType

public OfferDiscountType getOfferDiscountType()

The payment mode you configure for the offer.

Returns:

offerDiscountType

See Also:

• offerDiscountType

getRawOfferDiscountType

public String getRawOfferDiscountType()

See Also:

• getOfferDiscountType()

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:

• eligibleWinBackOfferIds

setEligibleWinBackOfferIds

public void setEligibleWinBackOfferIds(List<String> eligibleWinBackOfferIds)

appTransactionId

public JWSRenewalInfoDecodedPayload appTransactionId(String appTransactionId)

getAppTransactionId

public String getAppTransactionId()

The unique identifier of the app download transaction.

Returns:

appTransactionId

See Also:

• appTransactionId

setAppTransactionId

public void setAppTransactionId(String appTransactionId)

offerPeriod

public JWSRenewalInfoDecodedPayload offerPeriod(String offerPeriod)

getOfferPeriod

public String getOfferPeriod()

The duration of the offer.

Returns:

offerPeriod

See Also:

• offerPeriod

setOfferPeriod

public void setOfferPeriod(String offerPeriod)

appAccountToken

public JWSRenewalInfoDecodedPayload appAccountToken(UUID appAccountToken)

getAppAccountToken

public UUID getAppAccountToken()

The UUID that an app optionally generates to map a customer’s In-App Purchase with its resulting App Store transaction.

Returns:

appAccountToken

See Also:

• appAccountToken

setAppAccountToken

public void setAppAccountToken(UUID appAccountToken)

advancedCommerceInfo

public JWSRenewalInfoDecodedPayload advancedCommerceInfo(AdvancedCommerceRenewalInfo advancedCommerceInfo)

getAdvancedCommerceInfo

public AdvancedCommerceRenewalInfo getAdvancedCommerceInfo()

Renewal information that is present only for Advanced Commerce SKUs.

Returns:

advancedCommerceInfo

See Also:

• advancedCommerceRenewalInfo

setAdvancedCommerceInfo

public void setAdvancedCommerceInfo(AdvancedCommerceRenewalInfo advancedCommerceInfo)

commitmentInfo

public JWSRenewalInfoDecodedPayload commitmentInfo(RenewalCommitmentInfo commitmentInfo)

getCommitmentInfo

public RenewalCommitmentInfo getCommitmentInfo()

Returns:

commitmentInfo

See Also:

• RenewalCommitmentInfo

setCommitmentInfo

public void setCommitmentInfo(RenewalCommitmentInfo commitmentInfo)

renewalBillingPlanType

public JWSRenewalInfoDecodedPayload renewalBillingPlanType(RenewalBillingPlanType renewalBillingPlanType)

getRenewalBillingPlanType

public RenewalBillingPlanType getRenewalBillingPlanType()

Returns:

renewalBillingPlanType

See Also:

• renewalBillingPlanType

getRawRenewalBillingPlanType

public String getRawRenewalBillingPlanType()

See Also:

• getRenewalBillingPlanType()

setRenewalBillingPlanType

public void setRenewalBillingPlanType(RenewalBillingPlanType renewalBillingPlanType)

setRawRenewalBillingPlanType

public void setRawRenewalBillingPlanType(String rawRenewalBillingPlanType)

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