: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/StoreSubscriptionInfo.xml.

.. _class_StoreSubscriptionInfo:

StoreSubscriptionInfo
=====================

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

Provides subscription group metadata and status queries.

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

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

This class wraps StoreKit subscription information and exposes the subscription group metadata for a product.

Use the status methods to query the current subscription status for a product, subscription group, or transaction ID.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+------------------------------------------------------------------------------------------+--------+
   | :ref:`String<class_String>` | :ref:`group_display_name<class_StoreSubscriptionInfo_property_group_display_name>`       | ``""`` |
   +-----------------------------+------------------------------------------------------------------------------------------+--------+
   | :ref:`int<class_int>`       | :ref:`group_level<class_StoreSubscriptionInfo_property_group_level>`                     | ``-1`` |
   +-----------------------------+------------------------------------------------------------------------------------------+--------+
   | :ref:`String<class_String>` | :ref:`subscription_group_id<class_StoreSubscriptionInfo_property_subscription_group_id>` | ``""`` |
   +-----------------------------+------------------------------------------------------------------------------------------+--------+

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

Methods
-------

.. table::
   :widths: auto

   +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`getStatus<class_StoreSubscriptionInfo_method_getStatus>`\ (\ callback\: :ref:`Callable<class_Callable>`\ )                                                                 |
   +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`status_for_group_id<class_StoreSubscriptionInfo_method_status_for_group_id>`\ (\ group_id\: :ref:`String<class_String>`, status\: :ref:`Callable<class_Callable>`\ )       |
   +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`status_for_transaction<class_StoreSubscriptionInfo_method_status_for_transaction>`\ (\ transaction_id\: :ref:`int<class_int>`, status\: :ref:`Callable<class_Callable>`\ ) |
   +--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

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

.. _class_StoreSubscriptionInfo_property_group_display_name:

.. rst-class:: classref-property

:ref:`String<class_String>` **group_display_name** = ``""`` :ref:`🔗<class_StoreSubscriptionInfo_property_group_display_name>`

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

- :ref:`String<class_String>` **get_group_display_name**\ (\ )

The localized display name of the subscription group. Returns an empty string if unavailable.

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

----

.. _class_StoreSubscriptionInfo_property_group_level:

.. rst-class:: classref-property

:ref:`int<class_int>` **group_level** = ``-1`` :ref:`🔗<class_StoreSubscriptionInfo_property_group_level>`

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

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

The subscription group level used for upgrade/downgrade ranking. Returns ``-1`` when unavailable.

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

----

.. _class_StoreSubscriptionInfo_property_subscription_group_id:

.. rst-class:: classref-property

:ref:`String<class_String>` **subscription_group_id** = ``""`` :ref:`🔗<class_StoreSubscriptionInfo_property_subscription_group_id>`

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

- :ref:`String<class_String>` **get_subscription_group_id**\ (\ )

The subscription group identifier from App Store Connect. Returns an empty string if unavailable.

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

----

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

Method Descriptions
-------------------

.. _class_StoreSubscriptionInfo_method_getStatus:

.. rst-class:: classref-method

|void| **getStatus**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_StoreSubscriptionInfo_method_getStatus>`

Fetches the current status entries for this subscription. The callback receives a ``Array[StoreSubscriptionInfoStatus]`` on success, or a ``String`` describing the error.

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

----

.. _class_StoreSubscriptionInfo_method_status_for_group_id:

.. rst-class:: classref-method

|void| **status_for_group_id**\ (\ group_id\: :ref:`String<class_String>`, status\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_StoreSubscriptionInfo_method_status_for_group_id>`

Fetches status entries for the subscription group identifier. The callback receives a ``Array[StoreSubscriptionInfoStatus]`` on success, or a ``String`` describing the error.

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

----

.. _class_StoreSubscriptionInfo_method_status_for_transaction:

.. rst-class:: classref-method

|void| **status_for_transaction**\ (\ transaction_id\: :ref:`int<class_int>`, status\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_StoreSubscriptionInfo_method_status_for_transaction>`

Fetches the status entry for the provided transaction identifier. The callback receives a ``StoreSubscriptionInfoStatus`` when available, an empty ``Array[StoreSubscriptionInfoStatus]`` when no status is found, or a ``String`` describing the error.

On macOS, this requires macOS 15.4 or newer; earlier versions perform no action.

.. |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.)`