Interface JWSRenewalInfoDecodedPayload

A decoded payload containing subscription renewal information for an auto-renewable subscription.

JWSRenewalInfoDecodedPayload

interface JWSRenewalInfoDecodedPayload {
    appAccountToken?: string;
    appTransactionId?: string;
    autoRenewProductId?: string;
    autoRenewStatus?: number;
    currency?: string;
    eligibleWinBackOfferIds?: string[];
    environment?: string;
    expirationIntent?: number;
    gracePeriodExpiresDate?: number;
    isInBillingRetryPeriod?: boolean;
    offerDiscountType?: string;
    offerIdentifier?: string;
    offerPeriod?: string;
    offerType?: number;
    originalTransactionId?: string;
    priceIncreaseStatus?: number;
    productId?: string;
    recentSubscriptionStartDate?: number;
    renewalDate?: number;
    renewalPrice?: number;
    signedDate?: number;
}

Hierarchy (View Summary)

Properties

appAccountToken? appTransactionId? autoRenewProductId? autoRenewStatus? currency? eligibleWinBackOfferIds? environment? expirationIntent? gracePeriodExpiresDate? isInBillingRetryPeriod? offerDiscountType? offerIdentifier? offerPeriod? offerType? originalTransactionId? priceIncreaseStatus? productId? recentSubscriptionStartDate? renewalDate? renewalPrice? signedDate?

Properties

OptionalappAccountToken

appAccountToken?: string

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

appAccountToken

OptionalappTransactionId

appTransactionId?: string

The unique identifier of the app download transaction.

appTransactionId

OptionalautoRenewProductId

autoRenewProductId?: string

The product identifier of the product that will renew at the next billing period.

autoRenewProductId

OptionalautoRenewStatus

autoRenewStatus?: number

The renewal status of the auto-renewable subscription.

autoRenewStatus

Optionalcurrency

currency?: string

The currency code for the renewalPrice of the subscription.

currency

OptionaleligibleWinBackOfferIds

eligibleWinBackOfferIds?: string[]

An array of win-back offer identifiers that a customer is eligible to redeem, which sorts the identifiers to present the better offers first.

eligibleWinBackOfferIds

Optionalenvironment

environment?: string

The server environment, either sandbox or production.

environment

OptionalexpirationIntent

expirationIntent?: number

The reason the subscription expired.

expirationIntent

OptionalgracePeriodExpiresDate

gracePeriodExpiresDate?: number

The time when the billing grace period for subscription renewals expires.

gracePeriodExpiresDate

OptionalisInBillingRetryPeriod

isInBillingRetryPeriod?: boolean

A Boolean value that indicates whether the App Store is attempting to automatically renew an expired subscription.

isInBillingRetryPeriod

OptionalofferDiscountType

offerDiscountType?: string

The payment mode of the discount offer.

offerDiscountType

OptionalofferIdentifier

offerIdentifier?: string

The identifier that contains the promo code or the promotional offer identifier.

offerIdentifier

OptionalofferPeriod

offerPeriod?: string

The duration of the offer.

offerPeriod

OptionalofferType

offerType?: number

The type of the subscription offer.

offerType

OptionaloriginalTransactionId

originalTransactionId?: string

The original transaction identifier of a purchase.

originalTransactionId

OptionalpriceIncreaseStatus

priceIncreaseStatus?: number

The status that indicates whether the auto-renewable subscription is subject to a price increase.

priceIncreaseStatus

OptionalproductId

productId?: string

The unique identifier for the product, that you create in App Store Connect.

productId

OptionalrecentSubscriptionStartDate

recentSubscriptionStartDate?: number

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.

recentSubscriptionStartDate

OptionalrenewalDate

renewalDate?: number

The UNIX time, in milliseconds, when the most recent auto-renewable subscription purchase expires.

renewalDate

OptionalrenewalPrice

renewalPrice?: number

The renewal price, in milliunits, of the auto-renewable subscription that renews at the next billing period.

renewalPrice

OptionalsignedDate

signedDate?: number

The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.

signedDate

Settings

Member Visibility

On This Page

Properties