Event Actions
=============


Paid Content Identify
~~~~~~~~~~~~~~~~~~~~~

Triggered when a user clicks on the Paid Content Identify Button. This button is always part of the Purchase Overlay.


.. _event_actions_paid_content_purchase:

Paid Content Purchase
~~~~~~~~~~~~~~~~~~~~~

Triggered when a user clicks the Paid Content Purchase Button to start a checkout process for the selected purchase option. This button is part of the Purchase Overlay.

When using :ref:`Custom Analytics Integration <analytics_custom_analytics_integration>`, this Event Action comes with the following Additional Event Data:

- ``title`` The title of the currently selected purchase option
- ``price`` An object containing the following properties of the currently selected purchase option:

    * ``currency``
    * ``amount`` The amount in cents
    * ``payment_model`` "pay_now" or "pay_later"

- ``sales_model`` "single_purchase", "timepass" or "subscription"

Legacy Support
--------------

The follow Additional Event Data is still supported, but deprecated in Connector Script 3:

- ``purchaseType`` The payment model (formerly named "purchase type") of the currently selected purchase option, "ppu" represents "Pay Later" (formerly named "Pay Per Use") and "sis" represents payment model "Pay Now" (formerly named "Single Item Sale"). This field has been replaced by ``sales_model``.
- ``price`` An object containing a ``currency: price`` pair for the currently selected purchase option

Examples:
---------

Example of Additional Event Data for a Single Purchase:

.. code-block:: javascript

    {
      "title": "This article",
      "price": {
        "amount": 50,
        "currency": "EUR",
        "payment_model": "pay_later"
      },
      "sales_model": "single_purchase"
    }

Example of Additional Event Data for a Time Pass:

.. code-block:: javascript

    {
      "title": "Example One Day Time Pass",
      "price": {
        "amount": 100,
        "currency": "EUR",
        "payment_model": "pay_now"
      },
      "sales_model": "timepass"
    }


Paid Content Purchase Complete
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Triggered when a user returns after having completed a checkout process for a Single Purchase, Time Pass or Subscription purchase option.

This event comes with the same Additional Event Data as the event :ref:`Paid Content Purchase <event_actions_paid_content_purchase>`.


Paid Content Replacement Show
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Triggered when the Paid Content Replacement has been rendered.

The Paid Content Replacement consists of the Purchase Overlay and the blurrend replacement content.


..
    This should not be publicly documented according to https://laterpay.atlassian.net/browse/CONNECTOR-917?focusedCommentId=55518&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-55518
..
    Paid Content Cancel
    ~~~~~~~~~~~~~~~~~~~
..
    Triggered when a user clicks on the Paid Content Cancel Button. This button is an optional part of the Purchase Overlay variant "video". It appears only when In-Page Configuration Callback "On Cancel" is
    registered.