Interface JWSTransactionDecodedPayload

A decoded payload containing transaction information.

JWSTransactionDecodedPayload

interface JWSTransactionDecodedPayload {
    appAccountToken?: string;
    bundleId?: string;
    currency?: string;
    environment?: string;
    expiresDate?: number;
    inAppOwnershipType?: string;
    isUpgraded?: boolean;
    offerDiscountType?: string;
    offerIdentifier?: 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 full)

Properties

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

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

OptionalbundleId

bundleId?: string

The bundle identifier of an app.

bundleId

Optionalcurrency

currency?: string

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

currency

Optionalenvironment

environment?: string

The server environment, either sandbox or production.

environment

OptionalexpiresDate

expiresDate?: number

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

expiresDate

OptionalinAppOwnershipType

inAppOwnershipType?: string

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

inAppOwnershipType

OptionalisUpgraded

isUpgraded?: boolean

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

isUpgraded

OptionalofferDiscountType

offerDiscountType?: string

The payment mode you configure for an introductory offer, promotional offer, or offer code on an auto-renewable subscription.

offerDiscountType

OptionalofferIdentifier

offerIdentifier?: string

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

offerIdentifier

OptionalofferType

offerType?: number

A value that represents the promotional offer type.

offerType

OptionaloriginalPurchaseDate

originalPurchaseDate?: number

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

originalPurchaseDate

OptionaloriginalTransactionId

originalTransactionId?: string

The original transaction identifier of a purchase.

originalTransactionId

Optionalprice

price?: number

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

price

OptionalproductId

productId?: string

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

productId

OptionalpurchaseDate

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

Optionalquantity

quantity?: number

The number of consumable products purchased.

quantity

OptionalrevocationDate

revocationDate?: number

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

revocationDate

OptionalrevocationReason

revocationReason?: number

The reason that the App Store refunded the transaction or revoked it from family sharing.

revocationReason

OptionalsignedDate

signedDate?: number

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

signedDate

Optionalstorefront

storefront?: string

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

storefront

OptionalstorefrontId

storefrontId?: string

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

storefrontId

OptionalsubscriptionGroupIdentifier

subscriptionGroupIdentifier?: string

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

subscriptionGroupIdentifier

OptionaltransactionId

transactionId?: string

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

transactionId

OptionaltransactionReason

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

Optionaltype

type?: string

The type of the in-app purchase.

type

OptionalwebOrderLineItemId

webOrderLineItemId?: string

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

webOrderLineItemId

Settings

Member Visibility

On This Page

Properties