Interface VerifiedPurchase

A purchase object returned by the receipt validator

interface VerifiedPurchase {
    cancelationReason?: CancelationReason;
    discountId?: string;
    expiryDate?: number;
    id: string;
    isAcknowledged?: boolean;
    isBillingRetryPeriod?: boolean;
    isConsumed?: boolean;
    isExpired?: boolean;
    isIntroPeriod?: boolean;
    isTrialPeriod?: boolean;
    lastRenewalDate?: number;
    platform?: Platform;
    priceConsentStatus?: PriceConsentStatus;
    purchaseDate?: number;
    purchaseId?: string;
    quantity?: number;
    renewalIntent?: string;
    renewalIntentChangeDate?: number;
    transactionId?: string;
}

Properties

cancelationReason? discountId? expiryDate? id isAcknowledged? isBillingRetryPeriod? isConsumed? isExpired? isIntroPeriod? isTrialPeriod? lastRenewalDate? platform? priceConsentStatus? purchaseDate? purchaseId? quantity? renewalIntent? renewalIntentChangeDate? transactionId?

Properties

Optional cancelationReason

cancelationReason?: CancelationReason

The reason a subscription or purchase was cancelled.

Optional discountId

discountId?: string

Identifier of the discount currently applied to a purchase.

Correspond to the product's offerId. When undefined it means there is only one offer for the given product.

Optional expiryDate

expiryDate?: number

Date of expiry for a subscription.

id

id: string

Product identifier

Optional isAcknowledged

isAcknowledged?: boolean

True when a purchase has been acknowledged to the platform.

Optional isBillingRetryPeriod

isBillingRetryPeriod?: boolean

True when a subscription a subscription is in the grace period after a failed attempt to collect payment

Optional isConsumed

isConsumed?: boolean

True when a purchase has been consumed (for consumable products).

Optional isExpired

isExpired?: boolean

True when a subscription is expired.

Optional isIntroPeriod

isIntroPeriod?: boolean

True when a subscription is in introductory pricing period

Optional isTrialPeriod

isTrialPeriod?: boolean

True when a subscription is in trial period

Optional lastRenewalDate

lastRenewalDate?: number

Last time a subscription was renewed.

Optional platform

platform?: Platform

Platform this purchase was made on

Optional priceConsentStatus

priceConsentStatus?: PriceConsentStatus

Whether or not the user agreed or has been notified of a price change.

Optional purchaseDate

purchaseDate?: number

Date of first purchase (timestamp).

Optional purchaseId

purchaseId?: string

Purchase identifier (optional)

Optional quantity

quantity?: number

Quantity of items purchased in a single transaction.

For consumable products, this value represents the number of items purchased. For non-consumable products and subscriptions, this value is always 1.

Optional renewalIntent

renewalIntent?: string

Renewal intent.

Optional renewalIntentChangeDate

renewalIntentChangeDate?: number

Date the renewal intent was updated by the user.

Optional transactionId

transactionId?: string

Identifier of the last transaction (optional)

Settings

Member Visibility

Theme

On This Page

cancelationReasondiscountIdexpiryDateidisAcknowledgedisBillingRetryPeriodisConsumedisExpiredisIntroPeriodisTrialPeriodlastRenewalDateplatformpriceConsentStatuspurchaseDatepurchaseIdquantityrenewalIntentrenewalIntentChangeDatetransactionId