Interface IapticVerifiedPurchase

Purchase verified by the receipt validator.

interface IapticVerifiedPurchase {
    cancelationReason?: IapticCancelationReason;
    discountId?: string;
    expiryDate?: number;
    id: string;
    isAcknowledged?: boolean;
    isBillingRetryPeriod?: boolean;
    isExpired?: boolean;
    isIntroPeriod?: boolean;
    isTrialPeriod?: boolean;
    lastRenewalDate?: number;
    platform?: IapticPurchasePlatform;
    priceConsentStatus?: IapticPriceConsentStatus;
    productId: string;
    purchaseDate?: number;
    purchaseId?: string;
    renewalIntent?: "Renew" | "Lapse";
    renewalIntentChangeDate?: number;
    transactionId?: string;
}

Properties

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

Properties

OptionalcancelationReason

cancelationReason?: IapticCancelationReason

The reason a subscription or purchase was cancelled.

OptionaldiscountId

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.

OptionalexpiryDate

expiryDate?: number

Date of expiry for a subscription.

id

id: string

Product identifier

Deprecated

Use productId instead

OptionalisAcknowledged

isAcknowledged?: boolean

True when a purchase has been acknowledged

OptionalisBillingRetryPeriod

isBillingRetryPeriod?: boolean

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

OptionalisExpired

isExpired?: boolean

True when a subscription is expired.

OptionalisIntroPeriod

isIntroPeriod?: boolean

True when a subscription is in introductory pricing period

OptionalisTrialPeriod

isTrialPeriod?: boolean

True when a subscription is in trial period

OptionallastRenewalDate

lastRenewalDate?: number

Last time a subscription was renewed.

Optionalplatform

platform?: IapticPurchasePlatform

Platform this purchase was made on

OptionalpriceConsentStatus

priceConsentStatus?: IapticPriceConsentStatus

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

productId

productId: string

Product identifier

OptionalpurchaseDate

purchaseDate?: number

Date of first purchase (timestamp).

OptionalpurchaseId

purchaseId?: string

Purchase identifier (optional)

OptionalrenewalIntent

renewalIntent?: "Renew" | "Lapse"

Whether or not the user intends to let the subscription auto-renew.

Possible values:

  • "Renew" - The user intends to renew the subscription.
  • "Lapse" - The user intends to let the subscription expire without renewing.

OptionalrenewalIntentChangeDate

renewalIntentChangeDate?: number

Date the renewal intent was updated by the user.

OptionaltransactionId

transactionId?: string

Identifier of the last transaction (optional)

Settings

Member Visibility

On This Page

Properties