Interface AdaptySubscription

Interface representing details about a user's subscription.

Hierarchy

  • AdaptySubscription

Properties

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

Properties

Readonly activatedAt

activatedAt: Date

The date and time when the subscription 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 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 subscription, if applicable.

Readonly isActive

isActive: boolean

Flag indicating whether the subscription is currently active.

Readonly isInGracePeriod

isInGracePeriod: boolean

Flag indicating whether the subscription is in the grace period.

Readonly isLifetime

isLifetime: boolean

Flag indicating whether the subscription is set for a lifetime.

Readonly isRefund

isRefund: boolean

Flag indicating whether the subscription was refunded.

Readonly isSandbox

isSandbox: boolean

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

Optional Readonly renewedAt

renewedAt?: Date

The date and time when the subscription was renewed.

Optional Readonly startsAt

startsAt?: Date

The date and time when the subscription starts.

Readonly store

store: VendorStore

The store where the subscription was made.

Optional Readonly unsubscribedAt

unsubscribedAt?: Date

The date and time when the subscription was cancelled.

Readonly vendorOriginalTransactionId

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.

Readonly vendorProductId

vendorProductId: string

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

Readonly vendorTransactionId

vendorTransactionId: string

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

Readonly willRenew

willRenew: boolean

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc