Receipt Events

events name parameters supported platforms description product purchased packagename (string) productid (string) transactionid (string) deviceid or accountid android android ios ios triggered for a new one time product purchase (single purchase) note a purchase is considered new, if the receipt was uploaded within 10 minutes of purchasing product cancelled packagename (string) productid (string) transactionid (string) deviceid or accountid android android ios ios triggered when a one time product purchase (single purchase) was cancelled, e g due to a refund by apple support / the developer subscription purchased name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid trialperiod, boolean introofferperiod, boolean android android ios ios triggered for new subscription purchases note a purchase is considered new, if the receipt was uploaded within 10 minutes of purchasing subscription upgraded packagename (string) previousproductid (string) nextproductid (string) transactionid (string) deviceid or accountid (string) android android ios ios the subscription has been upgraded by the user for ios ios the current subscription will end immediately and then the new one will start for android android a subscription has been changed to a different product and the new subscription has a higher price the start of the new subscription depends on the selected proration mode during purchase subscription downgraded packagename (string) previousproductid (string) nextproductid (string) transactionid (string) deviceid or accountid (string) android android ios ios the subscription has been downgraded by the user for ios ios the current subscription will end normally and then the new one will start for android android a subscription has been changed to a different product and the new subscription has a lower price the start of the new subscription depends on the selected proration mode during purchase subscription resubscribed name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid a previously expired subscription has ben restarted/resubscribed by the user subscription resubscribed other packagename (string) previousproductid (string) nextproductid (string) transactionid (string) deviceid or accountid (string) ios ios a subscription has expired; user resubscribed to another sku (upgrade or downgrade) subscription cancelled name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid triggered when the renewal of a subscription has been cancelled by the user the subscription will continue until the expiration date is reached subscription cancelled involuntary name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid a subscription has been cancelled after it failed to renew the subscription due to billing problems subscription renewed name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid android android ios ios the subscription has been renewed for another period subscription renewal failed name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid android android ios ios the subscription could not be renewed due to billing issues it is still active and the system will retry to renew it when it succeeds it will result in a subscription recovered event or if it fails in a subscription cancelled involuntary event, subscription recovered name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid a subscription that previously failed to renew has been renewed / recovered subscription expired name, type, description packagename, string productid, string transactionid, string originaltransactionid, string, an identifier that stays the same across all events for this subscription deviceid, string, mutually exclusive with accountid accountid, string, mutually exclusive with deviceid android android ios ios the subscription reached its expiration date and is now considered expired account assignments changed name, type, description appid, string accountid, string android android ios ios the assignments of an account changed event format example { "version" "1 0", "type" "subscription cancelled", "properties" { "deviceid" "1122334455", "productid" "com example product1" }, "eventtimemillis" 11223344l } json schema { "$schema" "https //json schema org/draft 07/schema#", "contentmediatype" "application/vnd+sprylab purple aeb event+json", "title" "event", "properties" { "version" { "type" "string", "const" "1 0" }, "type" { "type" "string" }, "eventtimemillis" { "type" "number" }, "properties" { "type" "object", "additionalproperties" { "type" "string" } } }, "required" \[ "type", "properties", "eventtimemillis" ] }