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

.. _class_StoreProductPaymentMode:

StoreProductPaymentMode
=======================

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

The payment modes for subscription offers that apply to a transaction.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+--------------------------------------------------------------------------------------------+--------+
   | :ref:`String<class_String>` | :ref:`localized_description<class_StoreProductPaymentMode_property_localized_description>` | ``""`` |
   +-----------------------------+--------------------------------------------------------------------------------------------+--------+

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

Methods
-------

.. table::
   :widths: auto

   +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPaymentMode<class_StoreProductPaymentMode>` | :ref:`get_free_trial<class_StoreProductPaymentMode_method_get_free_trial>`\ (\ ) |static|       |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPaymentMode<class_StoreProductPaymentMode>` | :ref:`get_pay_as_you_go<class_StoreProductPaymentMode_method_get_pay_as_you_go>`\ (\ ) |static| |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPaymentMode<class_StoreProductPaymentMode>` | :ref:`pay_up_front<class_StoreProductPaymentMode_method_pay_up_front>`\ (\ ) |static|           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------+

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

----

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

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

.. _class_StoreProductPaymentMode_property_localized_description:

.. rst-class:: classref-property

:ref:`String<class_String>` **localized_description** = ``""`` :ref:`🔗<class_StoreProductPaymentMode_property_localized_description>`

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

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

The localized description of the payment mode.

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

----

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

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

.. _class_StoreProductPaymentMode_method_get_free_trial:

.. rst-class:: classref-method

:ref:`StoreProductPaymentMode<class_StoreProductPaymentMode>` **get_free_trial**\ (\ ) |static| :ref:`🔗<class_StoreProductPaymentMode_method_get_free_trial>`

Returns a payment mode representing a free trial.

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

----

.. _class_StoreProductPaymentMode_method_get_pay_as_you_go:

.. rst-class:: classref-method

:ref:`StoreProductPaymentMode<class_StoreProductPaymentMode>` **get_pay_as_you_go**\ (\ ) |static| :ref:`🔗<class_StoreProductPaymentMode_method_get_pay_as_you_go>`

Returns a payment mode where the user pays as they go (e.g. monthly for 3 months).

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

----

.. _class_StoreProductPaymentMode_method_pay_up_front:

.. rst-class:: classref-method

:ref:`StoreProductPaymentMode<class_StoreProductPaymentMode>` **pay_up_front**\ (\ ) |static| :ref:`🔗<class_StoreProductPaymentMode_method_pay_up_front>`

Returns a payment mode where the user pays the entire amount up front.

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