Unity IAP supports Product subscription information queries through the SubscriptionManager
class. For example code, please review the IAPDemo.cs script included in the Unity IAPAbbreviation of Unity In App Purchase
See in Glossary SDK 1.19+.
This class supports the Apple store and Google Play store. For Google Play, this class only supports Products purchased using IAP SDK 1.19+.
Method | Description |
---|---|
public SubscriptionInfo getSubscriptionInfo() |
Returns a SubscriptionInfo object (see below) |
The SubscriptionInfo
class is a container for a Product’s subscription-related information.
Method | Description |
---|---|
public string getProductId() |
Returns a Product’s store ID. |
public DateTime getPurchaseDate() |
Returns the Product’s purchase date. For Apple, the purchase date is the date when the subscription was either purchased or renewed. For Google, the purchase date is the date when the subscription was originally purchased. |
public Result isSubscribed() |
Returns a Result enum to indicate whether this Product is currently subscribed or not. Non-renewable Products in the Apple store return a Result.Unsupported value. Auto-renewable Products in the Apple store and subscription products in the Google Play store return a Result.True or Result.False value. |
public Result isExpired() |
Returns a Result enum to indicate whether this Product has expired or not. * Non-renewable Products in the Apple store return a Result.Unsupported value.* Auto-renewable Products in the Apple store and subscription products in the Google Play store return a Result.True or Result.False value. |
public Result isCancelled() |
Returns a Result enum to indicate whether this Product has been cancelled. A cancelled subscription means the Product is currently subscribed, but will not renew on the next billing date.Non-renewable Products in the Apple store return a Result.Unsupported value. Auto-renewable Products in the Apple store and subscription products in the Google Play store return a Result.True or Result.False value. |
public Result isFreeTrial() |
Returns a Result enum to indicate whether this Product is a free trial. * Products in the Google Play store return Result.Unsupported if the application does not support version 6+ of the Android in-app billing API. Non-renewable Products in the Apple store return a Result.Unsupported value. Auto-renewable Products in the Apple store and subscription products in the Google Play store return a Result.True or Result.False value. |
public Result isAutoRenewing() |
Returns a Result enum to indicate whether this Product is auto-renewable.Non-renewable Products in the Apple store return a Result.Unsupported value. Auto-renewable Products in the Apple store and subscription products in the Google Play store return a Result.True or Result.False value. |
public TimeSpan getRemainingTime() |
Returns a TimeSpan to indicate how much time remains until the next billing date. Products in the Google Play store return TimeSpan.MaxValue if the application does not support version 6+ of the Android in-app billing API. |
public Result isIntroductoryPricePeriod() |
Returns a Result enum to indicate whether this Product is within an introductory price period.On-renewable Products in the Apple store return a Result.Unsupported value. Auto-renewable Products in the Apple store and subscription products in the Google Play store return a Result.True or Result.False value. Products in the Google Play store return Result. Unsupported if the application does not support version 6+ of the Android in-app billing API. |
public TimeSpan getIntroductoryPricePeriod() |
Returns a TimeSpan to indicate how much time remains for the introductory price period.Subscription products with no introductory price period return TimeSpan.Zero . Products in the Apple store return TimeSpan.Zero if the application does not support iOS version 11.2+, macOS 10.13.2+, or tvOS 11.2+. |
public long getIntroductoryPricePeriodCycles() |
Returns the number of introductory price periods that can be applied to this Product. Products in the Apple store return 0 if the application does not support iOS version 11.2+, macOS 10.13.2+, or tvOS 11.2+. |
public string getIntroductoryPrice() |
Returns a string to indicate the introductory price of the Product. Products with no introductory price return a "not available" value. Apple store Products with an introductory price return a value formatted as “0.99USD” . Google Play Products with an introductory price return a value formatted as “$0.99” . Products in the Apple store return “not available” if the application does not support iOS version 11.2+, macOS 10.13.2+, or tvOS 11.2+. |
public DateTime getExpireDate() |
Returns the date of the Product’s next auto-renew or expiration (for a cancelled auto-renewing subscription). Products in the Google Play store return TimeSpan.MaxValue if the application does not support version 6+ of the Android in-app billing API. |
2018–05–30 Page published
Added Subscription Product support in 2018.1 NewIn20181
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.