Get Transaction History

Get a customer’s in-app purchase transaction history for your app.

URL

GET https://api.storekit.apple.com/inApps/v2/history/{anyTransactionId}

Sandbox URL

GET https://api.storekit-sandbox.apple.com/inApps/v2/history/{anyTransactionId}

Path Parameters

Name	Type	Description
`anyTransactionId` Required	`anyTransactionId`	Any originalTransactionId, transactionId or appTransactionId that belongs to the customer for your app.

Query Parameters

Name	Type	Description
`revision` Optional	`revision`	A token you provide to get the next set of up to 20 transactions. All responses include a `revision` token. Use the `revision` token from the previous HistoryResponse. Note: The `revision` token is required in all requests except the initial request. For requests that use the `revision` token, include the same query parameters from the initial request.
`startDate` Optional	`startDate`	An optional start date of the timespan for the transaction history records you’re requesting. The `startDate` needs to precede the `endDate` if you specify both dates. The results include a transaction if its purchaseDate is equal to or greater than the `startDate`.
`endDate` Optional	`endDate`	An optional end date of the timespan for the transaction history records you’re requesting. Choose an `endDate` that’s later than the `startDate` if you specify both dates. Using an `endDate` in the future is valid. The results include a transaction if its purchaseDate is less than the `endDate`.
`productId` Optional	[`productId`]	An optional filter that indicates the product identifier to include in the transaction history. Your query may specify more than one `productID`.
`productType` Optional	[string]	An optional filter that indicates the product type to include in the transaction history. Your query may specify more than one `productType`.
`inAppOwnershipType` Optional	`inAppOwnershipType`	An optional filter that limits the transaction history by the in-app ownership type.
`sort` Optional	string	An optional sort order for the transaction history records. The response sorts the transaction records by their recently modified date. The default value is `ASCENDING`, so you receive the oldest records first.
`revoked` Optional	boolean	An optional Boolean value that indicates whether the response includes only revoked transactions when the value is `true`, or contains only nonrevoked transactions when the value is `false`. By default, the request doesn’t include this parameter.
`subscriptionGroupIdentifier` Optional	[`subscriptionGroupIdentifier`]	An optional filter that indicates the subscription group identifier to include in the transaction history. Your query may specify more than one `subscriptionGroupIdentifier`.
`excludeRevoked` Optional	boolean	Set `revoked` to `false` to exclude revoked transactions instead.

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`HistoryResponse`	Request succeeded.
400	Bad Request Content-Type: application/json	(`InvalidAppIdentifierError` \| `InvalidRequestRevisionError` \| `InvalidTransactionIdError` \| `InvalidSortError` \| `InvalidStartDateError` \| `InvalidEndDateError` \| `InvalidProductTypeError` \| `InvalidProductIdError` \| `InvalidSubscriptionGroupIdentifierError` \| `InvalidInAppOwnershipTypeError` \| `InvalidExcludeRevokedError` \| `InvalidRevokedError`)	Invalid request.
401	Unauthorized		The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests.
404	Not Found Content-Type: application/json	(`AccountNotFoundError` \| `AccountNotFoundRetryableError` \| `AppNotFoundError` \| `AppNotFoundRetryableError` \| `TransactionIdNotFoundError`)
429	Content-Type: application/json	`RateLimitExceededError`	The request exceeded the rate limit.
500	Internal Server Error Content-Type: application/json	(`GeneralInternalError` \| `GeneralInternalRetryableError`)	Server error. Try again later.

Mentioned in

Discussion

The Get Transaction History endpoint returns results for all in-app purchase product types: auto-renewable subscriptions, non-renewing subscriptions, non-consumable, and consumable. The result returns transactions in any state, including transactions that are refunded or revoked, and transactions that the app has or hasn’t marked as finished.

You can customize your request by including query parameters that filter the transaction history. The query parameters limit the scope of the request by dates, product IDs, product types, and subscription group identifiers. You can also exclude revoked or nonrevoked transactions, and limit the transactions by in-app ownership type. If you provide multiple filters in the query, the transactions that return match all the filters.

You can also specify a sort order. The App Store sorts the transactions based on their recently modified dates. Use a DESCENDING order to get the most recent transactions first. The App Store updates the recently modified date if the customer upgrades a subscription or the App Store revokes an in-app purchase. If a transaction updates while you’re receiving transaction history and the response is sorted in ASCENDING order, you may receive the transaction again with updated data.

The productId, productType, and subscriptionGroupIdentifier query parameters allow you to specify multiple values. To specify more than one value for a query parameter, include it in the request multiple times. For example, to filter the transaction history by non-consumable and auto-renewable product types, include the following within your request:

GET https://api.storekit.apple.com/inApps/v2/history/{anyTransactionId}?productType=NON_CONSUMABLE&productType=AUTO_RENEWABLE

When you specify multiple values for a single query parameter, the response contains transactions that match any of the values.

To request a full transaction history in ascending order for your app, start by calling the endpoint without any query parameters, as follows:

GET https://api.storekit.apple.com/inApps/v2/history/{anyTransactionId}}

For subsequent requests, include the revision token from the previous HistoryResponse.

GET https://api.storekit.apple.com/inApps/v2/history/{anyTransactionId}?revision={revision}