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

.. _class_StoreTransaction:

StoreTransaction
================

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

Represents a successful purchase transaction.

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

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

This class contains details about a purchase, such as the product ID, purchase date, and expiration date (for subscriptions).

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`float<class_float>`   | :ref:`expiration_date<class_StoreTransaction_property_expiration_date>` | ``0.0``       |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`bool<class_bool>`     | :ref:`is_upgraded<class_StoreTransaction_property_is_upgraded>`         | ``false``     |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`int<class_int>`       | :ref:`original_id<class_StoreTransaction_property_original_id>`         | ``0``         |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`String<class_String>` | :ref:`ownership_type<class_StoreTransaction_property_ownership_type>`   | ``"unknown"`` |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`String<class_String>` | :ref:`product_id<class_StoreTransaction_property_product_id>`           | ``""``        |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`float<class_float>`   | :ref:`purchase_date<class_StoreTransaction_property_purchase_date>`     | ``0.0``       |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`float<class_float>`   | :ref:`revocation_date<class_StoreTransaction_property_revocation_date>` | ``0.0``       |
   +-----------------------------+-------------------------------------------------------------------------+---------------+
   | :ref:`int<class_int>`       | :ref:`transaction_id<class_StoreTransaction_property_transaction_id>`   | ``0``         |
   +-----------------------------+-------------------------------------------------------------------------+---------------+

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

----

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

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

.. _class_StoreTransaction_property_expiration_date:

.. rst-class:: classref-property

:ref:`float<class_float>` **expiration_date** = ``0.0`` :ref:`🔗<class_StoreTransaction_property_expiration_date>`

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

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

The date when the subscription expires, as a Unix timestamp. Returns 0 if not applicable.

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

----

.. _class_StoreTransaction_property_is_upgraded:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **is_upgraded** = ``false`` :ref:`🔗<class_StoreTransaction_property_is_upgraded>`

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

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

Whether this transaction is an upgrade of another transaction.

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

----

.. _class_StoreTransaction_property_original_id:

.. rst-class:: classref-property

:ref:`int<class_int>` **original_id** = ``0`` :ref:`🔗<class_StoreTransaction_property_original_id>`

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

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

The transaction identifier of the original purchase.

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

----

.. _class_StoreTransaction_property_ownership_type:

.. rst-class:: classref-property

:ref:`String<class_String>` **ownership_type** = ``"unknown"`` :ref:`🔗<class_StoreTransaction_property_ownership_type>`

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

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

The type of ownership (e.g., "purchased", "familyShared", "unknown").

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

----

.. _class_StoreTransaction_property_product_id:

.. rst-class:: classref-property

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

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

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

The unique identifier of the purchased product.

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

----

.. _class_StoreTransaction_property_purchase_date:

.. rst-class:: classref-property

:ref:`float<class_float>` **purchase_date** = ``0.0`` :ref:`🔗<class_StoreTransaction_property_purchase_date>`

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

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

The date when the purchase was made, as a Unix timestamp.

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

----

.. _class_StoreTransaction_property_revocation_date:

.. rst-class:: classref-property

:ref:`float<class_float>` **revocation_date** = ``0.0`` :ref:`🔗<class_StoreTransaction_property_revocation_date>`

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

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

The date when the transaction was revoked, as a Unix timestamp. Returns 0 if not revoked.

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

----

.. _class_StoreTransaction_property_transaction_id:

.. rst-class:: classref-property

:ref:`int<class_int>` **transaction_id** = ``0`` :ref:`🔗<class_StoreTransaction_property_transaction_id>`

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

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

The unique identifier of the transaction.

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