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

    Interface JWSTransactionDecodedPayload

    A decoded payload containing transaction information.

    JWSTransactionDecodedPayload

    interface JWSTransactionDecodedPayload {
        appAccountToken?: string;
        appTransactionId?: string;
        bundleId?: string;
        currency?: string;
        environment?: string;
        expiresDate?: number;
        inAppOwnershipType?: string;
        isUpgraded?: boolean;
        offerDiscountType?: string;
        offerIdentifier?: string;
        offerPeriod?: string;
        offerType?: number;
        originalPurchaseDate?: number;
        originalTransactionId?: string;
        price?: number;
        productId?: string;
        purchaseDate?: number;
        quantity?: number;
        revocationDate?: number;
        revocationReason?: number;
        signedDate?: number;
        storefront?: string;
        storefrontId?: string;
        subscriptionGroupIdentifier?: string;
        transactionId?: string;
        transactionReason?: string;
        type?: string;
        webOrderLineItemId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    appAccountToken? appTransactionId? bundleId? currency? environment? expiresDate? inAppOwnershipType? isUpgraded? offerDiscountType? offerIdentifier? offerPeriod? offerType? originalPurchaseDate? originalTransactionId? price? productId? purchaseDate? quantity? revocationDate? revocationReason? signedDate? storefront? storefrontId? subscriptionGroupIdentifier? transactionId? transactionReason? type? webOrderLineItemId?

    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

    bundleId?: string

    The bundle identifier of an app.

    bundleId

    currency?: string

    The three-letter ISO 4217 currency code for the price of the product.

    currency

    environment?: string

    The server environment, either sandbox or production.

    environment

    expiresDate?: number

    The UNIX time, in milliseconds, an auto-renewable subscription expires or renews.

    expiresDate

    inAppOwnershipType?: string

    A string that describes whether the transaction was purchased by the user, or is available to them through Family Sharing.

    inAppOwnershipType

    isUpgraded?: boolean

    The Boolean value that indicates whether the user upgraded to another subscription.

    isUpgraded

    offerDiscountType?: string

    The payment mode you configure for the offer.

    offerDiscountType

    offerIdentifier?: string

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

    offerIdentifier

    offerPeriod?: string

    The duration of the offer.

    offerPeriod

    offerType?: number

    A value that represents the promotional offer type.

    offerType

    originalPurchaseDate?: number

    The purchase date of the transaction associated with the original transaction identifier.

    originalPurchaseDate

    originalTransactionId?: string

    The original transaction identifier of a purchase.

    originalTransactionId

    price?: number

    The price, in milliunits, of the in-app purchase or subscription offer that you configured in App Store Connect.

    price

    productId?: string

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

    productId

    purchaseDate?: number

    The time that the App Store charged the user’s account for an in-app purchase, a restored in-app purchase, a subscription, or a subscription renewal after a lapse.

    purchaseDate

    quantity?: number

    The number of consumable products purchased.

    quantity

    revocationDate?: number

    The UNIX time, in milliseconds, that Apple Support refunded a transaction.

    revocationDate

    revocationReason?: number

    The reason that the App Store refunded the transaction or revoked it from Family Sharing.

    revocationReason

    signedDate?: number

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

    signedDate

    storefront?: string

    The three-letter code that represents the country or region associated with the App Store storefront for the purchase.

    storefront

    storefrontId?: string

    An Apple-defined value that uniquely identifies the App Store storefront associated with the purchase.

    storefrontId

    subscriptionGroupIdentifier?: string

    The identifier of the subscription group that the subscription belongs to.

    subscriptionGroupIdentifier

    transactionId?: string

    The unique identifier for a transaction such as an in-app purchase, restored in-app purchase, or subscription renewal.

    transactionId

    transactionReason?: string

    The reason for the purchase transaction, which indicates whether it’s a customer’s purchase or a renewal for an auto-renewable subscription that the system initates.

    transactionReason

    type?: string

    The type of the in-app purchase.

    type

    webOrderLineItemId?: string

    The unique identifier of subscription-purchase events across devices, including renewals.

    webOrderLineItemId

    Settings

    Member Visibility

    On This Page

    Properties