appstoreserverlibrary.models.TransactionHistoryRequest module

class appstoreserverlibrary.models.TransactionHistoryRequest.Order(value)[source]

Bases: str, Enum

ASCENDING = 'ASCENDING'
DESCENDING = 'DESCENDING'
class appstoreserverlibrary.models.TransactionHistoryRequest.ProductType(value)[source]

Bases: str, Enum

AUTO_RENEWABLE = 'AUTO_RENEWABLE'
CONSUMABLE = 'CONSUMABLE'
NON_CONSUMABLE = 'NON_CONSUMABLE'
NON_RENEWABLE = 'NON_RENEWABLE'
class appstoreserverlibrary.models.TransactionHistoryRequest.TransactionHistoryRequest(startDate: int | None = None, endDate: int | None = None, productIds: List[str] | None = None, productTypes: List[ProductType] | None = None, sort: Order | None = None, subscriptionGroupIdentifiers: List[str] | None = None, inAppOwnershipType: InAppOwnershipType | None = None, revoked: bool | None = None)[source]

Bases: object

endDate: int | None

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. To be included in results, the transaction’s purchaseDate must be less than the endDate.

https://developer.apple.com/documentation/appstoreserverapi/enddate

inAppOwnershipType: InAppOwnershipType | None

An optional filter that limits the transaction history by the in-app ownership type.

https://developer.apple.com/documentation/appstoreserverapi/inappownershiptype

productIds: List[str] | None

An optional filter that indicates the product identifier to include in the transaction history. Your query may specify more than one productID.

https://developer.apple.com/documentation/appstoreserverapi/productid

productTypes: List[ProductType] | None

An optional filter that indicates the product type to include in the transaction history. Your query may specify more than one productType.

revoked: bool | None

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.

sort: Order | None

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.

startDate: int | None

An optional start date of the timespan for the transaction history records you’re requesting. The startDate must precede the endDate if you specify both dates. To be included in results, the transaction’s purchaseDate must be equal to or greater than the startDate.

https://developer.apple.com/documentation/appstoreserverapi/startdate

subscriptionGroupIdentifiers: List[str] | None

An optional filter that indicates the subscription group identifier to include in the transaction history. Your query may specify more than one subscriptionGroupIdentifier.

https://developer.apple.com/documentation/appstoreserverapi/subscriptiongroupidentifier