Purchase events

8 min

Getting started

In the graphic below you can see the part that is covered in this chapter:

A purple application technically consists of a native part and an experience part that runs within a web view.

The purchase events in this documentation are listed under the Native app or Experience subchapters based on the origin they occur.

Native app

Currently no specific native purchase events are existing.

Experience

STOREFRONT_ISSUE_PURCHASED

Trigger

Placeholders

Examples

Android / iOS:

When an issue purchase succeeded.

"STOREFRONT_ISSUE_PURCHASED": {
    "templates": {
        "action": "issue_purchased"
    },
    "parameters": {
        "transaction_id": "{{TRANSACTION_ID}}",
        "issue_product_id": "{{PRODUCT_ID}}",
        "issue_price": "{{PRICE}}",
        "issue_price_currency": "{{CURRENCY_CODE}}",
        "issue_id": "{{ISSUE_ID}}",
        "issue_name": "{{ISSUE_NAME}}",
        "issue_type": "{{ISSUE_TYPE}}",
        "issue_categories": "{{ISSUE_CATEGORIES}}",
        "issue_tags": "{{ISSUE_TAGS}}",
        "issue_price_formatted": "{{ISSUE_PRICE}}",
        "issue_latest": "{{ISSUE_LATEST}}",
        "publication_id": "{{PUBLICATION_ID}}",
        "publication_name": "{{PUBLICATION_NAME}}",
        "publication_type": "{{PUBLICATION_TYPE}}"
    }
}

STOREFRONT_SUBSCRIPTION_PURCHASED

Trigger

Placeholders

Examples

Android / iOS:

When a subscription purchase succeeded.

"STOREFRONT_SUBSCRIPTION_PURCHASED": {
    "templates": {
        "action": "subscription_purchased"
    },
    "parameters": {
        "transaction_id": "{{TRANSACTION_ID}}",
        "subscription_product_id": "{{PRODUCT_ID}}",
        "subscription_price": "{{PRICE}}",
        "subscription_price_currency": "{{CURRENCY_CODE}}",
        "subscription_id": "{{SUBSCRIPTION_ID}}",
        "subscription_name": "{{SUBSCRIPTION_NAME}}",
        "subscription_type": "{{SUBSCRIPTION_TYPE}}",
        "subscription_duration": "{{SUBSCRIPTION_DURATION}}",
        "subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
        "subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
    }
}

STOREFRONT_SUBSCRIPTION_TRIAL_PURCHASED

Trigger

Placeholders

Examples

Android / iOS:

When a subscription purchase succeeded and the subscription has a trial period.

"STOREFRONT_SUBSCRIPTION_TRIAL_PURCHASED": {
    "templates": {
        "action": "subscription_trial_purchased"
    },
    "parameters": {
        "transaction_id": "{{TRANSACTION_ID}}",
        "subscription_product_id": "{{PRODUCT_ID}}",
        "subscription_price": "{{PRICE}}",
        "subscription_price_currency": "{{CURRENCY_CODE}}",
        "subscription_id": "{{SUBSCRIPTION_ID}}",
        "subscription_name": "{{SUBSCRIPTION_NAME}}",
        "subscription_type": "{{SUBSCRIPTION_TYPE}}",
        "subscription_duration": "{{SUBSCRIPTION_DURATION}}",
        "subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
        "subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
    }
}

STOREFRONT_PUBLICATION_COMPLETION_PURCHASED

Trigger

Placeholders

Examples

Android / iOS:

When a publication completion purchase succeeded.

"STOREFRONT_PUBLICATION_COMPLETION_PURCHASED": {
    "templates": {
        "action": "publication_completion_purchased"
    },
    "parameters": {
        "transaction_id": "{{TRANSACTION_ID}}",
        "product_id": "{{PRODUCT_ID}}",
        "product_price": "{{PRICE}}",
        "product_price_currency": "{{CURRENCY_CODE}}",
        "product_name": "{{PRODUCT_NAME}}",
        "product_type": "{{PRODUCT_TYPE}}",
        "product_description": "{{PRODUCT_DESCRIPTION}}",
        "product_hidden": "{{PRODUCT_HIDDEN}}",
        "product_price_formatted": "{{PRODUCT_PRICE}}",
        "product_purchased": "{{PRODUCT_PURCHASED}}"
    }
}