<!--
{
  "documentType" : "article",
  "framework" : "AppStoreServerAPI",
  "identifier" : "/documentation/AppStoreServerAPI/data-types",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Data types"
}
-->

# Data types

Refer to these data types for decoded transaction and renewal information payloads.

## Topics

### Environment

[`environment`](/documentation/AppStoreServerAPI/environment)

The server environment, either sandbox or production.

### Transaction identifiers

[`originalTransactionId`](/documentation/AppStoreServerAPI/originalTransactionId)

The original transaction identifier of a purchase.

[`transactionId`](/documentation/AppStoreServerAPI/transactionId)

The unique identifier for a transaction, such as an In-App Purchase, restored In-App Purchase, or subscription renewal.

[`webOrderLineItemId`](/documentation/AppStoreServerAPI/webOrderLineItemId)

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

[`anyTransactionId`](/documentation/AppStoreServerAPI/anyTransactionId)

A type that represents an original transaction ID, transaction ID, or app transaction ID.

### App transaction identifier

[`appTransactionId`](/documentation/AppStoreServerAPI/appTransactionId)

The unique identifier of the app download transaction.

### App information

[`appAppleId`](/documentation/AppStoreServerAPI/appAppleId)

The unique identifier of an app in the App Store.

[`bundleId`](/documentation/AppStoreServerAPI/bundleId)

The bundle identifier of an app.

[`originalApplicationVersion`](/documentation/AppStoreServerAPI/originalApplicationVersion)

The app version that the customer originally purchased from the App Store.

[`originalPlatform`](/documentation/AppStoreServerAPI/originalPlatform)

The platform on which a customer originally purchases an app.

[`preorderDate`](/documentation/AppStoreServerAPI/preorderDate)

The date a customer places an order for the app before it’s available in the App Store, expressed in UNIX time, in milliseconds.

### Account information

[`appAccountToken`](/documentation/AppStoreServerAPI/appAccountToken)

The UUID that you generate to associate a customer’s In-App Purchase with its resulting App Store transaction.

### Product information

[`productId`](/documentation/AppStoreServerAPI/productId)

The unique identifier of the product.

[`type`](/documentation/AppStoreServerAPI/type)

The type of In-App Purchase products you can offer in your app.

[`subscriptionGroupIdentifier`](/documentation/AppStoreServerAPI/subscriptionGroupIdentifier)

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

[`quantity`](/documentation/AppStoreServerAPI/quantity)

The number of purchased consumable products.

### Product price and currency

[`price`](/documentation/AppStoreServerAPI/price)

The price, in milliunits, of the In-App Purchase that the system records in the transaction.

[`currency`](/documentation/AppStoreServerAPI/currency)

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

### Storefront information

[`storefront`](/documentation/AppStoreServerAPI/storefront)

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

[`storefrontId`](/documentation/AppStoreServerAPI/storefrontId)

An Apple-defined value that uniquely identifies an App Store storefront.

### Offers

[`eligibleWinBackOfferIds`](/documentation/AppStoreServerAPI/eligibleWinBackOfferIds)

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

[`offerIdentifier`](/documentation/AppStoreServerAPI/offerIdentifier)

The string identifier of a subscription offer that you create in App Store Connect.

[`offerPeriod`](/documentation/AppStoreServerAPI/offerPeriod)

The duration of the offer.

[`offerType`](/documentation/AppStoreServerAPI/offerType)

The type of offer.

[`offerDiscountType`](/documentation/AppStoreServerAPI/offerDiscountType)

The payment mode for a discount offer on an In-App Purchase.

### Product purchase dates

[`originalPurchaseDate`](/documentation/AppStoreServerAPI/originalPurchaseDate)

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

[`purchaseDate`](/documentation/AppStoreServerAPI/purchaseDate)

The time that the App Store charged the customer’s account for an In-App Purchase, a restored In-App Purchase, a subscription, or a subscription renewal after a lapse.

[`recentSubscriptionStartDate`](/documentation/AppStoreServerAPI/recentSubscriptionStartDate)

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.

### Billing status

[`isInBillingRetryPeriod`](/documentation/AppStoreServerAPI/isInBillingRetryPeriod)

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

[`gracePeriodExpiresDate`](/documentation/AppStoreServerAPI/gracePeriodExpiresDate)

The time when the Billing Grace Period for subscription renewals expires.

### Subscription renewal and expiration

[`autoRenewStatus`](/documentation/AppStoreServerAPI/autoRenewStatus)

The renewal status for an auto-renewable subscription.

[`autoRenewProductId`](/documentation/AppStoreServerAPI/autoRenewProductId)

The identifier of the product that renews at the next billing period.

[`billingPlanType`](/documentation/AppStoreServerAPI/billingPlanType)

[`expirationIntent`](/documentation/AppStoreServerAPI/expirationIntent)

The reason an auto-renewable subscription expired.

[`expiresDate`](/documentation/AppStoreServerAPI/expiresDate)

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

[`isUpgraded`](/documentation/AppStoreServerAPI/isUpgraded)

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

[`renewalBillingPlanType`](/documentation/AppStoreServerAPI/renewalBillingPlanType)

[`renewalDate`](/documentation/AppStoreServerAPI/renewalDate)

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

[`renewalPrice`](/documentation/AppStoreServerAPI/renewalPrice)

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

[`status`](/documentation/AppStoreServerAPI/status)

The status of an auto-renewable subscription.

### Monthly subscriptions with 12-month commitments

[`TransactionCommitmentInfo`](/documentation/AppStoreServerAPI/TransactionCommitmentInfo)

[`billingPeriodNumber`](/documentation/AppStoreServerAPI/billingPeriodNumber)

[`commitmentExpiresDate`](/documentation/AppStoreServerAPI/commitmentExpiresDate)

[`commitmentPrice`](/documentation/AppStoreServerAPI/commitmentPrice)

[`totalBillingPeriods`](/documentation/AppStoreServerAPI/totalBillingPeriods)

[`RenewalCommitmentInfo`](/documentation/AppStoreServerAPI/RenewalCommitmentInfo)

[`commitmentAutoRenewProductId`](/documentation/AppStoreServerAPI/commitmentAutoRenewProductId)

[`commitmentAutoRenewStatus`](/documentation/AppStoreServerAPI/commitmentAutoRenewStatus)

[`commitmentRenewalBillingPlanType`](/documentation/AppStoreServerAPI/commitmentRenewalBillingPlanType)

[`commitmentRenewalDate`](/documentation/AppStoreServerAPI/commitmentRenewalDate)

[`commitmentRenewalPrice`](/documentation/AppStoreServerAPI/commitmentRenewalPrice)

### Family Sharing

[`inAppOwnershipType`](/documentation/AppStoreServerAPI/inAppOwnershipType)

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

### Price increase status

[`priceIncreaseStatus`](/documentation/AppStoreServerAPI/priceIncreaseStatus)

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

### Revocation

[`revocationDate`](/documentation/AppStoreServerAPI/revocationDate)

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

[`revocationReason`](/documentation/AppStoreServerAPI/revocationReason)

The reason for a refunded transaction.

[`revocationPercentage`](/documentation/AppStoreServerAPI/revocationPercentage)

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

[`revocationType`](/documentation/AppStoreServerAPI/revocationType)

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

### Transaction reason

[`transactionReason`](/documentation/AppStoreServerAPI/transactionReason)

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

### JSON Web Signature (JWS) date

[`signedDate`](/documentation/AppStoreServerAPI/signedDate)

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

[`receiptCreationDate`](/documentation/AppStoreServerAPI/receiptCreationDate)

The date that the App Store signs a JSON Web Signature (JWS) app transaction.

### Advanced Commerce API data

[Data types for Advanced Commerce API](/documentation/AppStoreServerAPI/advancedcommerce-datatypes)

Objects and data types for transactions that use the Advanced Commerce API.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)