api_version

Yes

int

Contains the webhook API version

event_name

Yes

string

Contains the name of the event

event_id

Yes

string

Contains the unique identifier of the event generated by Purchasely

event_created_at

Yes

string
in ISO 8601
Contains the date which the event was sent the first time. In case of retry that attribute will still be set with the time at the first try.

event_created_at_ms

Yes

int

in milliseconds since the Epoch
Contains the date which the event was sent the first time. In case of retry that attribute will still be set with the time at the first try.

anonymous_user_id

No

string

Contains the anonymous_user_id that holds the purchase.

That attribute will be filled with a Purchasely generated anonymous_user_id if your app doesn't require the user to be logged in and/or you didn't specified a user_id.

user_id

No

string

Contains the user_id that holds the purchase.

That attribute will be filled with the user_id you provided to the SDK.

store

No

string

Contains the name of the Store through which the purchase was made.

Possible values:
APPLE_APP_STORE
GOOGLE_PLAY_STORE
AMAZON_APPSTORE
HUAWEI_APPGALLERY
STRIPE

purchase_type

Yes

string

Contains the type of In-App Purchase

Possible values:
CONSUMABLE
NON_CONSUMABLE
NON_RENEWING_SUBSCRIPTION RENEWING_SUBSCRIPTION

product

Yes

string

Contains the Product id (=subscription group id) that carries the plan that was bought.

plan

No

string

Contains the Plan id that was bought.

content_id

No

string

Contains the content_id you may have set on the SDK to display the paywall

customer_currency

No

string

*inISO 4217 *

Contains the customer's store currency.

plan_price_in_xxx

No

float

Contains the price plan in the current period of its subscription (so 0 during a free trial) using the Default integration currency defined in the App Settings. This amount includes VAT..

xxx is the ISO 4217 code of the currency and will be replaced accordingly to the selected currency in the settings.

plan_price_in_customer_currency

No

float

Contains the price paid by a customer in its own currency (customer_currency) in the current period of its subscription (so 0 during a free trial).

amount_in_usd

No

float

⚠️ Only available for the event TRANSACTION_PROCESSED.

Contains the amount of the transaction associated with the event TRANSACTION_PROCESSED using the pivot currency which is USD. This amount includes VAT.

This amount can also be negative in case of a refund or an plan upgrade with a partial refund.

amount_in_xxx

No

float

⚠️ Only available for the event TRANSACTION_PROCESSED.

xxx is the ISO 4217 code of the currency and will be replaced accordingly to the selected currency in the settings.

⚠️ This field is only present if the selected currency in the settings is different from USD

Contains the amount of the transaction associated with the event TRANSACTION_PROCESSED using the Default integration currency defined in the App Settings. This amount includes VAT.

This amount can also be negative in case of a refund or an plan upgrade with a partial refund.

amount_in_customer_currency

No

string

⚠️ Only available for the event TRANSACTION_PROCESSED.

Contains the amount paid by a customer in the current period of its subscription (so 0 during a free trial) using the currency defined in Purchasely's App Settings.

source_event_name

No

string

⚠️ Only available for the event TRANSACTION_PROCESSED.

Contains the name of the subscription event which was associated with the event TRANSACTION_PROCESSED.

cumulated_revenues_in_xxx

No

float

Contains the cumulated revenues for the associated user in the currency defined in Purchasely's App Settings. This amount is VAT included.

xxx is the ISO 4217 code of the currency and will be replaced accordingly to the selected currency in the settings.

previous_plan

No

string

Contains the Plan vendor id the customer used to have before changing plan.

Used with for the following events:
SUBSCRIPTION_CROSSGRADED
SUBSCRIPTION_DOWNGRADED
SUBSCRIPTION_UPGRADED

previous_store_product_id

No

string

Contains the store product_id the customer used to have before changing plan.

Used with for the following events:
SUBSCRIPTION_CROSSGRADED
SUBSCRIPTION_DOWNGRADED
SUBSCRIPTION_UPGRADED

device_id

No

string

Contains the device id associated with the purchase.

This attribute is analogous to the anonymous_user_id and is auto generated by the Purchasely SDK

device_type

No

string

Contains the device type associated with the purchase.

Possible values:
COMPUTER
PAD
PHONE
TV

store_country

Yes

string

• in ISO 3166
• Contains the store country where the purchase was made.

Can be NULL in case the subscription was purchased before Purchasely was implemented in your system.

purchasely_subscription_id

No

string

Contains the Purchasely internal unique identifier of the subscription.

Used with events that regards a subscription.

from_purchasely_subscription_id

No

string

Used with events that regards a subscription.

Contains the Purchasely internal unique identifier of the subscription

Used with for the following events:
SUBSCRIPTION_CROSSGRADED
SUBSCRIPTION_DOWNGRADED
SUBSCRIPTION_UPGRADED

purchasely_one_time_purchase_id

No

string

Contains the Purchasely internal unique identifier of the one time purchase.

Used with all events that regards a one time purchase.

store_product_id

Yes

string

Contains the product_id you created in the store (Apple App Store, Google Play Console...)

store_transaction_id

Yes

string

Contains the transaction_id given by the store.

purchased_at

Yes

string

in ISO 8601

Contains the date of the last transaction (original purchase or renewal).

purchased_at_ms

Yes

int

in milliseconds since the Epoch

Contains the date of the last transaction (original purchase or renewal).

store_original_transaction_id

Yes

string

Contains the store_transaction_id of the first transaction.

original_purchased_at

Yes

string

in ISO 8601

Contains the date of the first transaction.

original_purchased_at_ms

Yes

int

in milliseconds since the Epoch

Contains the date of the first transaction.

transferred_from_anonymous_user_id

No

string

Contains the anonymous_user_id the subscription was transferred from.

That attribute is filled for the following event:
SUBSCRIPTION_RECEIVED

transferred_to_anonymous_user_id

No

string

Contains the anonymous_user_id the subscription was transferred to.

That attribute is filled for the following event:
SUBSCRIPTION_TRANSFERRED

transferred_from_user_id

No

string

Contains the user_id the subscription was transferred from.

That attribute is filled for the following event :
SUBSCRIPTION_RECEIVED

transferred_to_user_id

No

string

Contains the user_id the subscription was transferred to.

That attribute is filled for the following event:
SUBSCRIPTION_TRANSFERRED

environment

Yes

string

Contains the environment from where the purchase was made.

Possible values:
SANDBOX
PRODUCTION

is_family_shared

No

bool

Contains true or false depending on if the user has access to the subscription thanks to family sharing.

previous_offer_type

No

string

Contains the previous offer the subscription was under.

That attribute is always filled for events that regards subscriptions except for the very first ACTIVATE and SUBSCRIPTION_STARTED.

Possible values:

NONE: the user was paying the normal price, no offer associated
FREE_TRIAL
INTRO_OFFER
PROMO_CODE
PROMOTIONAL_OFFER

offer_type

Yes

string

Contains the current offer the subscription is under.

Possible values:
NONE: the user is paying the normal price, no offer associated
FREE_TRIAL
INTRO_OFFER
PROMO_CODE
PROMOTIONAL_OFFER

subscription_status

No

string

Contains the current status of the subscription.

Filled for events that regards a subscription.

Possible Values :
AUTO_RENEWING
ON_HOLD
IN_GRACE_PERIOD
AUTO_RENEWING_CANCELED
DEACTIVATED
REVOKED
PAUSED
UNPAID

grace_period_expires_at

No

string

• in ISO 8601
• Filled for events that regards a subscription which is in grace period.

Contains the date when the grace period will end.

grace_period_expires_at_ms

No

int

in milliseconds since the Epoch

Filled for events that regards a subscription which is in grace period.

Contains the date when the grace period will end

effective_next_renewal_at

No

string

in ISO 8601

Filled for events that regards a subscription.

Contains the effective next renewal date, taking any grace or defer periods into account. If the subscription isn’t in grace or deferring period the effective date is equal to next_renewal_at.

effective_next_renewal_at_ms

No

int

in milliseconds since the Epoch.

Filled for events that regards a subscription.

Contains the effective next renewal date, taking any grace or defer periods into account. If the subscription isn’t in grace or deferring period the effective date is equal to next_renewal_at.

next_renewal_at

No

string

in ISO 8601

Filled for events that regards a subscription.

Contains the theoretical next automatic renewal date.

See effective_newt_renewal_at.

next_renewal_at_ms

No

int

in milliseconds since the Epoch

Filled for events that regards a subscription.

Contains the theoretical next automatic renewal date.

See effective_next_renewal_at.

defer_end_at

No

string

in ISO 8601

Filled for events that regards a subscription.

Contains the date when the free time offered will be ending.

defer_end_at_ms

No

int

in milliseconds since the Epoch

Filled for events that regards a subscription.

Contains the date when the free time offered will be ending.

auto_resume_at

No

string

in ISO 8601

Filled for events that regards a subscription.

Contains the date when the pause will be ending and the subscription will resume.

auto_resume_at_ms

No

int

in milliseconds since the Epoch.

Filled for events that regards a subscription.

Contains the date when the pause will be ending and the subscription will resume.

presentation

No

string

Contains the id of the associated presentation when the initial purchase was made.

placement

No

string

Contains the id of the placement from where the subscription was bought.

ab_test

No

string

Contains the id of the running AB test when the initial purchase was made.

ab_test_variant

No

string

Contains the id of the AB test variant in which the user was when the initial purchase was made.

audience

No

string

Contains the id of the audience the user matched within the associated placement when the initial purchase was made.

purchase_token

No

string

Filled for events that regards Google Play Store transaction & subscription events

Contains the purchase token which is a unique identifier that represents the user and the store product ID for the in-app product they purchased

offer_code_ref_name

No

string

Filled for events that regards a subscription.

Contains the offer code ref name used when a customer successfully redeems an offer code.

This attribute is filled for the following event :
PROMO_CODE_STARTED
PROMO_CODE_CONVERTED
PROMO_CODE_NOT_CONVERTED

offer_identifier

No

string

Filled for events that regards a subscription.

Contains the offer identifier used when a customer successfully redeems an offer code or a promotional offer.

This attribute is filled for the following event :
PROMO_CODE_STARTED
PROMO_CODE_CONVERTED
PROMO_CODE_NOT_CONVERTED
PROMOTIONAL_OFFER_STARTED
PROMOTIONAL_OFFER_CONVERTED
PROMOTIONAL_OFFER_NOT_CONVERTED

promotional_offer_id

No

string

Filled for events that regards a subscription.

Contains the promotional offer identifier used when a customer successfully redeems a promotional offer.

This attribute is filled for the following event :
PROMOTIONAL_OFFER_STARTED
PROMOTIONAL_OFFER_CONVERTED
PROMOTIONAL_OFFER_NOT_CONVERTED

store_app_bundle_id

Yes

string

Contains the store bundle ID of the app in which the purchase was made.