Interface AdaptyAccessLevel

Interface representing access level details of a user.

Hierarchy

  • AdaptyAccessLevel

Properties

activatedAt activeIntroductoryOfferType? activePromotionalOfferId? activePromotionalOfferType? android? billingIssueDetectedAt? cancellationReason? expiresAt? id isActive isInGracePeriod isLifetime isRefund renewedAt? startsAt? store unsubscribedAt? vendorProductId willRenew

Properties

Readonly activatedAt

activatedAt: Date

The date and time when the access level was activated.

Optional Readonly activeIntroductoryOfferType

activeIntroductoryOfferType?: OfferType

Type of active introductory offer, if any.

Optional Readonly activePromotionalOfferId

activePromotionalOfferId?: string

Identifier of the active promotional offer, if any.

Optional Readonly activePromotionalOfferType

activePromotionalOfferType?: OfferType

Type of the active promotional offer, if any.

Optional android

android?: {
    offerId?: string;
}

Type declaration

  • Optional offerId?: string

Optional Readonly billingIssueDetectedAt

billingIssueDetectedAt?: Date

The date and time when a billing issue was detected.

Optional Readonly cancellationReason

cancellationReason?: CancellationReason

The reason for the cancellation of the subscription.

Optional Readonly expiresAt

expiresAt?: Date

The expiration date of the access level, if applicable.

Readonly id

id: string

Unique identifier of the access level configured by you in Adapty Dashboard.

Readonly isActive

isActive: boolean

Flag indicating whether the access level is currently active.

Readonly isInGracePeriod

isInGracePeriod: boolean

Flag indicating whether this auto-renewable subscription is in the grace period.

Readonly isLifetime

isLifetime: boolean

Flag indicating whether this access level is active for a lifetime.

Readonly isRefund

isRefund: boolean

Flag indicating whether this purchase was refunded.

Optional Readonly renewedAt

renewedAt?: Date

The date and time when the access level was renewed.

Optional Readonly startsAt

startsAt?: Date

The start date of this access level.

Readonly store

store: VendorStore

The store where the purchase that unlocked this access level was made.

Optional Readonly unsubscribedAt

unsubscribedAt?: Date

The date and time when the auto-renewable subscription was cancelled.

Readonly vendorProductId

vendorProductId: string

The identifier of the product in the store that unlocked this access level.

Readonly willRenew

willRenew: boolean

Flag indicating whether this auto-renewable subscription is set to renew.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc