@apple/app-store-server-library
    Preparing search index...

    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)

    Index

    Properties

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

    Properties

    appAccountToken?: string

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

    appAccountToken

    appTransactionId?: string

    The unique identifier of the app download transaction.

    appTransactionId

    autoRenewProductId?: string

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

    autoRenewProductId

    autoRenewStatus?: number

    The renewal status of the auto-renewable subscription.

    autoRenewStatus

    currency?: string

    The currency code for the renewalPrice of the subscription.

    currency

    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

    environment?: string

    The server environment, either sandbox or production.

    environment

    expirationIntent?: number

    The reason the subscription expired.

    expirationIntent

    gracePeriodExpiresDate?: number

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

    gracePeriodExpiresDate

    isInBillingRetryPeriod?: boolean

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

    isInBillingRetryPeriod

    offerDiscountType?: string

    The payment mode you configure for the offer.

    offerDiscountType

    offerIdentifier?: string

    The offer code or the promotional offer identifier.

    offerIdentifier

    offerPeriod?: string

    The duration of the offer.

    offerPeriod

    offerType?: number

    The type of subscription offer.

    offerType

    originalTransactionId?: string

    The original transaction identifier of a purchase.

    originalTransactionId

    priceIncreaseStatus?: number

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

    priceIncreaseStatus

    productId?: string

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

    productId

    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

    renewalDate?: number

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

    renewalDate

    renewalPrice?: number

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

    renewalPrice

    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