Contents

JWSTransactionDecodedPayload

A decoded payload that contains transaction information.

Declaration

object JWSTransactionDecodedPayload

Properties

NameTypeDescription
appAccountTokenappAccountToken

A UUID you create at the time of purchase that associates the transaction with a customer on your own service. If your app doesn’t provide an appAccountToken, this field is omitted. For more information, see appAccountToken(_:).

appTransactionIdappTransactionId

The unique identifier of the app download transaction.

bundleIdbundleId

The bundle identifier of the app.

currencycurrency

The three-letter ISO 4217 currency code associated with the price parameter. This value is present only if price is present.

environmentenvironment

The server environment, either sandbox or production.

expiresDateexpiresDate

The UNIX time, in milliseconds, that the subscription expires or renews.

inAppOwnershipTypeinAppOwnershipType

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

isUpgradedisUpgraded

A Boolean value that indicates whether the customer upgraded to another subscription.

offerDiscountTypeofferDiscountType

The payment mode you configure for the offer.

offerIdentifierofferIdentifier

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

offerPeriodofferPeriod

The duration of the offer applied to the transaction.

offerTypeofferType

A value that represents the promotional offer type.

originalPurchaseDateoriginalPurchaseDate

The UNIX time, in milliseconds, that represents the purchase date of the original transaction identifier.

originalTransactionIdoriginalTransactionId

The transaction identifier of the original purchase.

priceprice

An integer value that represents the price multiplied by 1000 of the in-app purchase or subscription offer you configured in App Store Connect and that the system records at the time of the purchase. For more information, see price. The currency parameter indicates the currency of this price.

productIdproductId

The unique identifier of the product.

purchaseDatepurchaseDate

The UNIX time, in milliseconds, that the App Store charged the customer’s account for a purchase, restored product, subscription, or subscription renewal after a lapse.

quantityquantity

The number of consumable products the customer purchased.

revocationDaterevocationDate

The UNIX time, in milliseconds, that the App Store refunded the transaction or revoked it from Family Sharing.

revocationPercentagerevocationPercentage

The percentage, in milliunits, of the transaction that the App Store has refunded or revoked.

revocationReasonrevocationReason

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

revocationTyperevocationType

The type of the refund or revocation that applies to the transaction.

signedDatesignedDate

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

storefrontstorefront

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

storefrontIdstorefrontId

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

subscriptionGroupIdentifiersubscriptionGroupIdentifier

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

transactionIdtransactionId

The unique identifier of the transaction.

transactionReasontransactionReason

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.

typetype

The type of the in-app purchase.

webOrderLineItemIdwebOrderLineItemId

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

advancedCommerceInfoadvancedCommerceTransactionInfo

Transaction information that is present only for Advanced Commerce SKUs.

billingPlanTypebillingPlanType
commitmentInfoTransactionCommitmentInfo

Mentioned in

Discussion

See Also

JWS headers and payloads