@adapty/capacitor - v3.10.0-beta.1
    Preparing search index...

    Interface AdaptySubscription

    Interface representing details about a user's subscription.

    interface AdaptySubscription {
        activatedAt: Date;
        activeIntroductoryOfferType?: OfferType;
        activePromotionalOfferId?: string;
        activePromotionalOfferType?: OfferType;
        billingIssueDetectedAt?: Date;
        cancellationReason?: CancellationReason;
        expiresAt?: Date;
        isActive: boolean;
        isInGracePeriod: boolean;
        isLifetime: boolean;
        isRefund: boolean;
        isSandbox: boolean;
        renewedAt?: Date;
        startsAt?: Date;
        store: VendorStore;
        unsubscribedAt?: Date;
        vendorOriginalTransactionId: string;
        vendorProductId: string;
        vendorTransactionId: string;
        willRenew: boolean;
    }
    Index

    Properties

    activatedAt activeIntroductoryOfferType? activePromotionalOfferId? activePromotionalOfferType? billingIssueDetectedAt? cancellationReason? expiresAt? isActive isInGracePeriod isLifetime isRefund isSandbox renewedAt? startsAt? store unsubscribedAt? vendorOriginalTransactionId vendorProductId vendorTransactionId willRenew

    Properties

    activatedAt: Date

    The date and time when the subscription was activated.

    activeIntroductoryOfferType?: OfferType

    Type of active introductory offer, if any.

    activePromotionalOfferId?: string

    Identifier of the active promotional offer, if any.

    activePromotionalOfferType?: OfferType

    Type of the active promotional offer, if any.

    billingIssueDetectedAt?: Date

    The date and time when a billing issue was detected.

    cancellationReason?: CancellationReason

    The reason for the cancellation of the subscription.

    expiresAt?: Date

    The expiration date of the subscription, if applicable.

    isActive: boolean

    Flag indicating whether the subscription is currently active.

    isInGracePeriod: boolean

    Flag indicating whether the subscription is in the grace period.

    isLifetime: boolean

    Flag indicating whether the subscription is set for a lifetime.

    isRefund: boolean

    Flag indicating whether the subscription was refunded.

    isSandbox: boolean

    Flag indicating whether the subscription was purchased in a sandbox environment.

    renewedAt?: Date

    The date and time when the subscription was renewed.

    startsAt?: Date

    The date and time when the subscription starts.

    store: VendorStore

    The store where the subscription was made.

    unsubscribedAt?: Date

    The date and time when the subscription was cancelled.

    vendorOriginalTransactionId: string

    An original transaction id of the purchase in a store that unlocked this subscription. For auto-renewable subscription, this will be an id of the first transaction in this subscription.

    vendorProductId: string

    The identifier of the product in the store that was subscribed to.

    vendorTransactionId: string

    The identifier of the product in the store that was subscribed to.

    willRenew: boolean

    Flag indicating whether the subscription is set to auto-renew.

    Settings

    Member Visibility

    On This Page

    Properties