AdaptySDK
AdaptySDK.AdaptyProfile.Subscription Class Reference

Public Member Functions

override string ToString ()

Public Attributes

readonly string Store
 The store of the purchase. The possible values are: app_store, play_store , adapty.
readonly string VendorProductId
 The identifier of the product in the App Store Connect.
readonly string VendorTransactionId
 Transaction id from the App Store.
readonly string VendorOriginalTransactionId
 Original transaction id from the App Store.
readonly bool IsActive
 Whether the subscription is active.
readonly bool IsLifetime
 Whether the subscription is active for a lifetime (no expiration date).
readonly DateTime ActivatedAt
 The time when the subscription was activated.
readonly? DateTime RenewedAt
 The time when the subscription was renewed.
readonly? DateTime ExpiresAt
 The time when the subscription will expire (could be in the past and could be null for lifetime access).
readonly? DateTime StartsAt
 The time when the subscription has started (could be in the future).
readonly? DateTime UnsubscribedAt
 The time when the auto-renewable subscription was cancelled.
readonly? DateTime BillingIssueDetectedAt
 The time when billing issue was detected (Apple was not able to charge the card).
readonly bool IsInGracePeriod
 Whether the auto-renewable subscription is in the grace period.
readonly bool IsSandbox
 Whether the product was purchased in the sandbox environment.
readonly bool IsRefund
 Whether the purchase was refunded.
readonly bool WillRenew
 Whether the auto-renewable subscription is set to renew.
readonly string ActiveIntroductoryOfferType
 The type of active introductory offer.
readonly string ActivePromotionalOfferType
 The type of active promotional offer.
readonly string ActivePromotionalOfferId
readonly string OfferId
readonly string CancellationReason
 The reason why the subscription was cancelled.

Package Functions

 Subscription (JSONObject jsonNode)

Constructor & Destructor Documentation

◆ Subscription()

AdaptySDK.AdaptyProfile.Subscription.Subscription ( JSONObject jsonNode)
package

Member Function Documentation

◆ ToString()

override string AdaptySDK.AdaptyProfile.Subscription.ToString ( )

Member Data Documentation

◆ ActivatedAt

readonly DateTime AdaptySDK.AdaptyProfile.Subscription.ActivatedAt

The time when the subscription was activated.

◆ ActiveIntroductoryOfferType

readonly string AdaptySDK.AdaptyProfile.Subscription.ActiveIntroductoryOfferType

The type of active introductory offer.

Possible values are: free_trial, pay_as_you_go, pay_up_front. If the value is not null, it means that the offer was applied during the current subscription period.

◆ ActivePromotionalOfferId

readonly string AdaptySDK.AdaptyProfile.Subscription.ActivePromotionalOfferId

◆ ActivePromotionalOfferType

readonly string AdaptySDK.AdaptyProfile.Subscription.ActivePromotionalOfferType

The type of active promotional offer.

Possible values are: free_trial, pay_as_you_go, pay_up_front. If the value is not null, it means that the offer was applied during the current subscription period.

◆ BillingIssueDetectedAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.BillingIssueDetectedAt

The time when billing issue was detected (Apple was not able to charge the card).

Subscription can still be active. Will be set to null if the charge will be made.

◆ CancellationReason

readonly string AdaptySDK.AdaptyProfile.Subscription.CancellationReason

The reason why the subscription was cancelled.

Possible values are: voluntarily_cancelled, billing_error, refund, price_increase, product_was_not_available, unknown.

◆ ExpiresAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.ExpiresAt

The time when the subscription will expire (could be in the past and could be null for lifetime access).

◆ IsActive

readonly bool AdaptySDK.AdaptyProfile.Subscription.IsActive

Whether the subscription is active.

◆ IsInGracePeriod

readonly bool AdaptySDK.AdaptyProfile.Subscription.IsInGracePeriod

Whether the auto-renewable subscription is in the grace period.

◆ IsLifetime

readonly bool AdaptySDK.AdaptyProfile.Subscription.IsLifetime

Whether the subscription is active for a lifetime (no expiration date).

If set to true you shouldn't check expires_at , or you could just check isActive.

◆ IsRefund

readonly bool AdaptySDK.AdaptyProfile.Subscription.IsRefund

Whether the purchase was refunded.

◆ IsSandbox

readonly bool AdaptySDK.AdaptyProfile.Subscription.IsSandbox

Whether the product was purchased in the sandbox environment.

◆ OfferId

readonly string AdaptySDK.AdaptyProfile.Subscription.OfferId

◆ RenewedAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.RenewedAt

The time when the subscription was renewed.

◆ StartsAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.StartsAt

The time when the subscription has started (could be in the future).

◆ Store

readonly string AdaptySDK.AdaptyProfile.Subscription.Store

The store of the purchase. The possible values are: app_store, play_store , adapty.

◆ UnsubscribedAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.UnsubscribedAt

The time when the auto-renewable subscription was cancelled.

Subscription can still be active, it just means that auto-renewal turned off. Will be set to null if the user reactivates the subscription.

◆ VendorOriginalTransactionId

readonly string AdaptySDK.AdaptyProfile.Subscription.VendorOriginalTransactionId

Original transaction id from the App Store.

For auto-renewable subscription, this will be the id of the first transaction in the subscription.

◆ VendorProductId

readonly string AdaptySDK.AdaptyProfile.Subscription.VendorProductId

The identifier of the product in the App Store Connect.

◆ VendorTransactionId

readonly string AdaptySDK.AdaptyProfile.Subscription.VendorTransactionId

Transaction id from the App Store.

◆ WillRenew

readonly bool AdaptySDK.AdaptyProfile.Subscription.WillRenew

Whether the auto-renewable subscription is set to renew.


The documentation for this class was generated from the following files: