Subscription Apps

10min

Purchase Click
When the user clicks on a button it may start the purchase. 
This is not the after-purchase event so a user may terminate the purchase flow.
Properties
Name
Type
Required
Description
amount
﻿Amount﻿﻿
Yes
Amount object with 
packID
String
Yes
Id of the pack
items
Array of Premium Item﻿ 
Yes
List of items (if specific items were purchased)
coupon
 Coupon﻿ 
No
Coupon if applied
Code Example
The following example includes optional properties too.
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "packID": "P1234",
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "isPaid": true,
            "hasTrial": false
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Purchase Click", props);
const props = {
    "packID": "P1234",
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "isPaid": true,
            "hasTrial": false
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Purchase Click", props);
﻿
Consumable Purchase
When the user purchases a consumable content/item.
Properties
Name
Type
Required
Description
amount
﻿Amount﻿﻿
Yes
Amount object with 
packID
String
Yes
Id of the pack
items
Array of Premium Item﻿ 
Yes
List of items (if specific items were purchased)
transactionID
String
Yes
TransactionId of the user purchase
coupon
 Coupon﻿ 
No
Coupon if applied
Code Example
The following example includes optional properties too.
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "packID": "P1234",
    "transactionID": "T1234",
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "isPaid": true,
            "hasTrial": false
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Consumable Purchase", props);
const props = {
    "packID": "P1234",
    "transactionID": "T1234",
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "isPaid": true,
            "hasTrial": false
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Consumable Purchase", props);
﻿
Subscribe
When the user purchases a consumable content/item.
Properties
Name
Type
Required
Description
amount
﻿Amount﻿﻿
Yes
Amount object with 
packID
String
Yes
Id of the pack
items
Array of Premium Item﻿ 
Yes
List of items (if specific items were purchased)
transactionID
String
Yes
TransactionId of the user purchase
type
String
Yes
subscription period like WEEKLY, MONTHLY, YEARLY.
coupon
 Coupon﻿ 
No
Coupon if applied
Code Example
The following example includes optional properties too.
JS
TypeScript
Java
Kotlin
ObjectiveC
Swift
Dart
const props = {
    "packID": "P1234",
    "transactionID": "T1234",
    "type": "MONTHLY",
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "isPaid": true,
            "hasTrial": false
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Subscribe", props);
const props = {
    "packID": "P1234",
    "transactionID": "T1234",
    "type": "MONTHLY",
    "items": [
        {
            "id": "1234",
            "name": "ITEM_NAME",
            "category": {
                "id": "1234",
                "name": "CATEGORY_NAME"
            },
            "isPaid": true,
            "hasTrial": false
        }
    ],
    "amount": {
        "value": 1134.50,
        "currency": "USD"
    },
    "coupon": {
        "id": "FOO-12345",
        "code": "FREE20",
        "amount": 20.0,
        "discountType": "percent"
    }   
};

cooeeSDK.sendEvent("Subscribe", props);
﻿
﻿

Name	Type	Required	Description
amount	Amount	Yes	Amount object with
packID	String	Yes	Id of the pack
items	Array of Premium Item	Yes	List of items (if specific items were purchased)
coupon	Coupon	No	Coupon if applied

Name	Type	Required	Description
amount	Amount	Yes	Amount object with
packID	String	Yes	Id of the pack
items	Array of Premium Item	Yes	List of items (if specific items were purchased)
transactionID	String	Yes	TransactionId of the user purchase
coupon	Coupon	No	Coupon if applied

Name	Type	Required	Description
amount	Amount	Yes	Amount object with
packID	String	Yes	Id of the pack
items	Array of Premium Item	Yes	List of items (if specific items were purchased)
transactionID	String	Yes	TransactionId of the user purchase
type	String	Yes	subscription period like WEEKLY, MONTHLY, YEARLY.
coupon	Coupon	No	Coupon if applied

Updated 25 Mar 2024

Did this page help you?

Social Apps

Video/Audio Apps