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

.. _class_StoreProductPurchaseOption:

StoreProductPurchaseOption
==========================

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

Represents an option that can be supplied when purchasing a :ref:`StoreProduct<class_StoreProduct>`.

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

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

You create instances of this class and you can pass those to :ref:`StoreKitManager.purchase_with_options()<class_StoreKitManager_method_purchase_with_options>`.

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

Methods
-------

.. table::
   :widths: auto

   +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` | :ref:`app_account_token<class_StoreProductPurchaseOption_method_app_account_token>`\ (\ stringUuidToken\: :ref:`String<class_String>`\ ) |static|                               |
   +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` | :ref:`introductory_offer_elligibility<class_StoreProductPurchaseOption_method_introductory_offer_elligibility>`\ (\ jws\: :ref:`String<class_String>`\ ) |static|               |
   +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` | :ref:`quantity<class_StoreProductPurchaseOption_method_quantity>`\ (\ value\: :ref:`int<class_int>`\ ) |static|                                                                 |
   +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` | :ref:`simulate_ask_to_buy_in_sandbox<class_StoreProductPurchaseOption_method_simulate_ask_to_buy_in_sandbox>`\ (\ enabled\: :ref:`bool<class_bool>`\ ) |static|                 |
   +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` | :ref:`win_back_offer<class_StoreProductPurchaseOption_method_win_back_offer>`\ (\ offer\: :ref:`StoreProductSubscriptionOffer<class_StoreProductSubscriptionOffer>`\ ) |static| |
   +---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

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

.. _class_StoreProductPurchaseOption_method_app_account_token:

.. rst-class:: classref-method

:ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` **app_account_token**\ (\ stringUuidToken\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_StoreProductPurchaseOption_method_app_account_token>`

Creates a purchase option with an app account token. This token should be a UUID string that associates the transaction with a user account on your service.

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

----

.. _class_StoreProductPurchaseOption_method_introductory_offer_elligibility:

.. rst-class:: classref-method

:ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` **introductory_offer_elligibility**\ (\ jws\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_StoreProductPurchaseOption_method_introductory_offer_elligibility>`

Creates a purchase option with a specific introductory offer eligibility. This requires the signed JWS string from the App Store.

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

----

.. _class_StoreProductPurchaseOption_method_quantity:

.. rst-class:: classref-method

:ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` **quantity**\ (\ value\: :ref:`int<class_int>`\ ) |static| :ref:`🔗<class_StoreProductPurchaseOption_method_quantity>`

Creates a purchase option specifying the quantity of the product to purchase.

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

----

.. _class_StoreProductPurchaseOption_method_simulate_ask_to_buy_in_sandbox:

.. rst-class:: classref-method

:ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` **simulate_ask_to_buy_in_sandbox**\ (\ enabled\: :ref:`bool<class_bool>`\ ) |static| :ref:`🔗<class_StoreProductPurchaseOption_method_simulate_ask_to_buy_in_sandbox>`

Creates a purchase option to simulate the "Ask to Buy" flow in the sandbox environment.

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

----

.. _class_StoreProductPurchaseOption_method_win_back_offer:

.. rst-class:: classref-method

:ref:`StoreProductPurchaseOption<class_StoreProductPurchaseOption>` **win_back_offer**\ (\ offer\: :ref:`StoreProductSubscriptionOffer<class_StoreProductSubscriptionOffer>`\ ) |static| :ref:`🔗<class_StoreProductPurchaseOption_method_win_back_offer>`

Creates a purchase option for a win-back offer.

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