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

.. _class_StoreProduct:

StoreProduct
============

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

Represents a product available for purchase in the App Store.

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

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

This class contains information about a product, such as its ID, display name, description, and price. It is returned by :ref:`StoreKitManager.request_products()<class_StoreKitManager_method_request_products>`.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`description_value<class_StoreProduct_property_description_value>`     | ``""``    |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`display_name<class_StoreProduct_property_display_name>`               | ``""``    |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`display_price<class_StoreProduct_property_display_price>`             | ``""``    |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>`     | :ref:`is_family_shareable<class_StoreProduct_property_is_family_shareable>` | ``false`` |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`json_representation<class_StoreProduct_property_json_representation>` | ``""``    |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`float<class_float>`   | :ref:`price<class_StoreProduct_property_price>`                             | ``0.0``   |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`product_id<class_StoreProduct_property_product_id>`                   | ``""``    |
   +-----------------------------+-----------------------------------------------------------------------------+-----------+

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

----

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

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

.. _class_StoreProduct_property_description_value:

.. rst-class:: classref-property

:ref:`String<class_String>` **description_value** = ``""`` :ref:`🔗<class_StoreProduct_property_description_value>`

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

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

A localized description of the product.

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

----

.. _class_StoreProduct_property_display_name:

.. rst-class:: classref-property

:ref:`String<class_String>` **display_name** = ``""`` :ref:`🔗<class_StoreProduct_property_display_name>`

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

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

The localized name of the product.

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

----

.. _class_StoreProduct_property_display_price:

.. rst-class:: classref-property

:ref:`String<class_String>` **display_price** = ``""`` :ref:`🔗<class_StoreProduct_property_display_price>`

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

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

The formatted price of the product, including currency symbol (e.g., "$0.99").

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

----

.. _class_StoreProduct_property_is_family_shareable:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **is_family_shareable** = ``false`` :ref:`🔗<class_StoreProduct_property_is_family_shareable>`

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

- :ref:`bool<class_bool>` **get_is_family_shareable**\ (\ )

Whether the product is shareable with family members.

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

----

.. _class_StoreProduct_property_json_representation:

.. rst-class:: classref-property

:ref:`String<class_String>` **json_representation** = ``""`` :ref:`🔗<class_StoreProduct_property_json_representation>`

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

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

A JSON string representation of the underlying StoreKit product, useful for debugging or accessing properties not exposed directly.

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

----

.. _class_StoreProduct_property_price:

.. rst-class:: classref-property

:ref:`float<class_float>` **price** = ``0.0`` :ref:`🔗<class_StoreProduct_property_price>`

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

- :ref:`float<class_float>` **get_price**\ (\ )

The price of the product as a number.

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

----

.. _class_StoreProduct_property_product_id:

.. rst-class:: classref-property

:ref:`String<class_String>` **product_id** = ``""`` :ref:`🔗<class_StoreProduct_property_product_id>`

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

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

The unique identifier of the product.

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