The request body containing consumption information.

ConsumptionRequest

interface ConsumptionRequest {
    accountTenure?: number;
    appAccountToken?: string;
    consumptionStatus?: number;
    customerConsented?: boolean;
    deliveryStatus?: number;
    lifetimeDollarsPurchased?: number;
    lifetimeDollarsRefunded?: number;
    platform?: number;
    playTime?: number;
    refundPreference?: number;
    sampleContentProvided?: boolean;
    userStatus?: number;
}

Properties

accountTenure?: number

The age of the customer’s account.

accountTenure

appAccountToken?: string

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

appAccountToken

consumptionStatus?: number

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

consumptionStatus

customerConsented?: boolean

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

customerConsented

deliveryStatus?: number

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

deliveryStatus

lifetimeDollarsPurchased?: number

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

lifetimeDollarsPurchased

lifetimeDollarsRefunded?: number

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

lifetimeDollarsRefunded

platform?: number

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

platform

playTime?: number

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

ConsumptionRequest

refundPreference?: number

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

refundPreference

sampleContentProvided?: boolean

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.

sampleContentProvided

userStatus?: number

The status of the customer’s account.

userStatus