storekit__get_transaction_history
Read-only
Get a customer's full purchase history from any one of their transaction IDs. Supports filtering by product type, product ID and date range.
Instructions
Get a customer's full purchase history from any one of their transaction IDs. Supports filtering by product type, product ID and date range. Returns Apple's SIGNED transactions (JWS strings) unless ASC_APPLE_ROOT_CERTS is set, in which case they arrive verified and decoded. [App Store Server API]
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Which app: its name, bundle ID or Apple ID. Optional when the account has one app or ASC_BUNDLE_ID is set. | |
| raw | No | Return Apple's signed JWS payloads instead of decoded fields, to verify them yourself. Ignored when ASC_APPLE_ROOT_CERTS is unset — the payloads are all there is then. | |
| sort | No | ||
| revoked | No | Filter by revoked status. | |
| max_pages | No | Pages to fetch, 20 transactions each (default 5). The result carries hasMore and a revision cursor when Apple still has more than this fetched. | |
| product_id | No | Filter to one product ID. | |
| environment | No | Which App Store environment to query. Defaults to the server-configured environment (ASC_ENVIRONMENT). A transaction ID belongs to one environment only. | |
| product_type | No | Filter by product type. | |
| transaction_id | Yes | Any transaction ID belonging to the customer. |