:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/../../GodotApplePlugins/doc_classes/StoreSubscriptionInfoStatus.xml.

.. _class_StoreSubscriptionInfoStatus:

StoreSubscriptionInfoStatus
===========================

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Describes the status of a subscription in a subscription group.

.. rst-class:: classref-introduction-group

Description
-----------

This class wraps StoreKit's subscription status information, including renewal state, verified renewal info, and the latest verified transaction.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +---------------------------------------------------------------------------------+------------------------------------------------------------------------------+----------+
   | :ref:`StoreSubscriptionInfoRenewalInfo<class_StoreSubscriptionInfoRenewalInfo>` | :ref:`renewal_info<class_StoreSubscriptionInfoStatus_property_renewal_info>` | ``null`` |
   +---------------------------------------------------------------------------------+------------------------------------------------------------------------------+----------+
   | :ref:`int<class_int>`                                                           | :ref:`state<class_StoreSubscriptionInfoStatus_property_state>`               | ``0``    |
   +---------------------------------------------------------------------------------+------------------------------------------------------------------------------+----------+
   | :ref:`StoreTransaction<class_StoreTransaction>`                                 | :ref:`transaction<class_StoreSubscriptionInfoStatus_property_transaction>`   | ``null`` |
   +---------------------------------------------------------------------------------+------------------------------------------------------------------------------+----------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_StoreSubscriptionInfoStatus_RenewalState:

.. rst-class:: classref-enumeration

enum **RenewalState**: :ref:`🔗<enum_StoreSubscriptionInfoStatus_RenewalState>`

.. _class_StoreSubscriptionInfoStatus_constant_UNKNOWN:

.. rst-class:: classref-enumeration-constant

:ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` **UNKNOWN** = ``0``

The renewal state is unknown or not available.

.. _class_StoreSubscriptionInfoStatus_constant_EXPIRED:

.. rst-class:: classref-enumeration-constant

:ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` **EXPIRED** = ``1``

The subscription has expired.

.. _class_StoreSubscriptionInfoStatus_constant_SUBSCRIBED:

.. rst-class:: classref-enumeration-constant

:ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` **SUBSCRIBED** = ``2``

The subscription is currently active.

.. _class_StoreSubscriptionInfoStatus_constant_IN_BILLING_RETRY_PERIOD:

.. rst-class:: classref-enumeration-constant

:ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` **IN_BILLING_RETRY_PERIOD** = ``3``

The subscription is in the billing retry period after a failed renewal.

.. _class_StoreSubscriptionInfoStatus_constant_IN_GRACE_PERIOD:

.. rst-class:: classref-enumeration-constant

:ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` **IN_GRACE_PERIOD** = ``4``

The subscription is in the grace period after a failed renewal.

.. _class_StoreSubscriptionInfoStatus_constant_REVOKED:

.. rst-class:: classref-enumeration-constant

:ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` **REVOKED** = ``5``

The subscription was revoked by Apple.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_StoreSubscriptionInfoStatus_property_renewal_info:

.. rst-class:: classref-property

:ref:`StoreSubscriptionInfoRenewalInfo<class_StoreSubscriptionInfoRenewalInfo>` **renewal_info** = ``null`` :ref:`🔗<class_StoreSubscriptionInfoStatus_property_renewal_info>`

.. rst-class:: classref-property-setget

- :ref:`StoreSubscriptionInfoRenewalInfo<class_StoreSubscriptionInfoRenewalInfo>` **get_renewal_info**\ (\ )

Verified renewal info for the subscription, or ``null`` if it is missing or unverified.

.. rst-class:: classref-item-separator

----

.. _class_StoreSubscriptionInfoStatus_property_state:

.. rst-class:: classref-property

:ref:`int<class_int>` **state** = ``0`` :ref:`🔗<class_StoreSubscriptionInfoStatus_property_state>`

.. rst-class:: classref-property-setget

- :ref:`int<class_int>` **get_state**\ (\ )

The current renewal state. Use the :ref:`RenewalState<enum_StoreSubscriptionInfoStatus_RenewalState>` constants.

.. rst-class:: classref-item-separator

----

.. _class_StoreSubscriptionInfoStatus_property_transaction:

.. rst-class:: classref-property

:ref:`StoreTransaction<class_StoreTransaction>` **transaction** = ``null`` :ref:`🔗<class_StoreSubscriptionInfoStatus_property_transaction>`

.. rst-class:: classref-property-setget

- :ref:`StoreTransaction<class_StoreTransaction>` **get_transaction**\ (\ )

The latest verified transaction for the subscription, or ``null`` if it is missing or unverified.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`