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

.. _class_StoreProductSubscriptionOffer:

StoreProductSubscriptionOffer
=============================

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

Represents a subscription offer for a :ref:`StoreProduct<class_StoreProduct>`.

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

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

You configure these in AppStore Connect.   See `Apple's documentation <https://developer.apple.com/documentation/storekit/product/subscriptionoffer>`__ for additional information

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

----

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

Enumerations
------------

.. _enum_StoreProductSubscriptionOffer_OfferType:

.. rst-class:: classref-enumeration

enum **OfferType**: :ref:`🔗<enum_StoreProductSubscriptionOffer_OfferType>`

.. _class_StoreProductSubscriptionOffer_constant_INTRODUCTORY:

.. rst-class:: classref-enumeration-constant

:ref:`OfferType<enum_StoreProductSubscriptionOffer_OfferType>` **INTRODUCTORY** = ``0``

An introductory offer for new subscribers.

.. _class_StoreProductSubscriptionOffer_constant_PROMOTIONAL:

.. rst-class:: classref-enumeration-constant

:ref:`OfferType<enum_StoreProductSubscriptionOffer_OfferType>` **PROMOTIONAL** = ``1``

A promotional offer for existing or lapsed subscribers.

.. _class_StoreProductSubscriptionOffer_constant_WIN_BACK:

.. rst-class:: classref-enumeration-constant

:ref:`OfferType<enum_StoreProductSubscriptionOffer_OfferType>` **WIN_BACK** = ``2``

A win-back offer for lapsed subscribers.

.. _class_StoreProductSubscriptionOffer_constant_UNKNOWN:

.. rst-class:: classref-enumeration-constant

:ref:`OfferType<enum_StoreProductSubscriptionOffer_OfferType>` **UNKNOWN** = ``3``

An unknown offer type.

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