AdaptySDK.AdaptyProfile.Subscription Class Reference

One subscription of a profile, as the store and Adapty currently see it. More...

Public Member Functions
override string	ToString ()
	A description for logs and the debugger. The format is not part of the contract — read the members rather than parsing it.

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 store it was bought from.
readonly string	VendorTransactionId
	The transaction id the store reported.
readonly string	VendorOriginalTransactionId
	The original transaction id the store reported.
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. Null when there has been no renewal.
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). Null when there is no start date.
readonly? DateTime	UnsubscribedAt
	The time when the auto-renewable subscription was cancelled.
readonly? DateTime	BillingIssueDetectedAt
	The time a billing issue was detected — the store could not charge the payment method.
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
	The App Store promotional offer in force right now. Null when there is none, and for a subscription bought on Android — the profile is one object across platforms, so this says where the purchase happened, not where the app runs.
readonly string	OfferId
	The Google Play offer the current period was bought with. Null when there was none, and for a subscription bought on iOS — see ActivePromotionalOfferId.
readonly string	CancellationReason
	The reason why the subscription was cancelled. Null when it was not.

Private Member Functions
	Subscription ()

Detailed Description

One subscription of a profile, as the store and Adapty currently see it.

Constructor & Destructor Documentation

Subscription()

AdaptySDK.AdaptyProfile.Subscription.Subscription ( )

private

Member Function Documentation

ToString()

override string AdaptySDK.AdaptyProfile.Subscription.ToString

(

)

A description for logs and the debugger. The format is not part of the contract — read the members rather than parsing it.

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

The App Store promotional offer in force right now. Null when there is none, and for a subscription bought on Android — the profile is one object across platforms, so this says where the purchase happened, not where the app runs.

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 a billing issue was detected — the store could not charge the payment method.

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. Null when it was not.

The values the native SDKs list: voluntarily_cancelled, billing_error, price_increase, product_was_not_available, refund, upgraded, unknown. It stays a string rather than an enum because the contract leaves the set open — do not write a switch that assumes these are all of them.

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

The Google Play offer the current period was bought with. Null when there was none, and for a subscription bought on iOS — see ActivePromotionalOfferId.

RenewedAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.RenewedAt

The time when the subscription was renewed. Null when there has been no renewal.

StartsAt

readonly? DateTime AdaptySDK.AdaptyProfile.Subscription.StartsAt

The time when the subscription has started (could be in the future). Null when there is no start date.

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

The original transaction id the store reported.

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 store it was bought from.

VendorTransactionId

readonly string AdaptySDK.AdaptyProfile.Subscription.VendorTransactionId

The transaction id the store reported.

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 file:

• Models/AdaptyProfile.Subscription.cs