appstoreserverlibrary.models.ConsumptionRequest module

class appstoreserverlibrary.models.ConsumptionRequest.ConsumptionRequest(customerConsented: bool | None = None, consumptionStatus: ConsumptionStatus | None = None, platform: Platform | None = None, sampleContentProvided: bool | None = None, deliveryStatus: DeliveryStatus | None = None, appAccountToken: str | None = None, accountTenure: AccountTenure | None = None, playTime: PlayTime | None = None, lifetimeDollarsRefunded: LifetimeDollarsRefunded | None = None, lifetimeDollarsPurchased: LifetimeDollarsPurchased | None = None, userStatus: UserStatus | None = None, refundPreference: RefundPreference | None = None, *, rawConsumptionStatus: int | None = None, rawPlatform: int | None = None, rawDeliveryStatus: int | None = None, rawAccountTenure: int | None = None, rawPlayTime: int | None = None, rawLifetimeDollarsRefunded: int | None = None, rawLifetimeDollarsPurchased: int | None = None, rawUserStatus: int | None = None, rawRefundPreference: int | None = None)

Bases: AttrsRawValueAware

The request body containing consumption information.

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

accountTenure: AccountTenure | None

The age of the customer’s account.

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

appAccountToken: str | None

The UUID that an app optionally generates to map a customer’s in-app purchase with its resulting App Store transaction.

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

consumptionStatus: ConsumptionStatus | None

A value that indicates the extent to which the customer consumed the in-app purchase.

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

customerConsented: bool | None

A Boolean value that indicates whether the customer consented to provide consumption data to the App Store.

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

deliveryStatus: DeliveryStatus | None

A value that indicates whether the app successfully delivered an in-app purchase that works properly.

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

lifetimeDollarsPurchased: LifetimeDollarsPurchased | None

A value that indicates the total amount, in USD, of in-app purchases the customer has made in your app, across all platforms.

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

lifetimeDollarsRefunded: LifetimeDollarsRefunded | None

A value that indicates the total amount, in USD, of refunds the customer has received, in your app, across all platforms.

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

platform: Platform | None

A value that indicates the platform on which the customer consumed the in-app purchase.

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

playTime: PlayTime | None

A value that indicates the amount of time that the customer used the app.

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

rawAccountTenure: int | None

See accountTenure

rawConsumptionStatus: int | None

See consumptionStatus

rawDeliveryStatus: int | None

See deliveryStatus

rawLifetimeDollarsPurchased: int | None

See lifetimeDollarsPurchased

rawLifetimeDollarsRefunded: int | None

See lifetimeDollarsRefunded

rawPlatform: int | None

See platform

rawPlayTime: int | None

See playTime

rawRefundPreference: int | None

See refundPreference

rawUserStatus: int | None

See userStatus

refundPreference: RefundPreference | None

A value that indicates your preference, based on your operational logic, as to whether Apple should grant the refund.

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

sampleContentProvided: bool | None

A Boolean value that indicates whether you provided, prior to its purchase, a free sample or trial of the content, or information about its functionality.

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

userStatus: UserStatus | None

The status of the customer’s account.

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