Skip to content

Tulo Engage BI

Model codes and values

Describes different values for properties on orders, subscriptions and accounts.

Subscription model

Field "created_from"

code/value comments
campaign_transformation created through a campaign transformation
downgrade created through a downgrade of the subscription
migration created as a part of a migration
upgrade created through an upgrade of the subscription
package_change created through a package change
payway_admin created from payway admin (PAP) as a free subscription
purchase created through a purchase
subscription_change created through a subscription change
voucher created by redeeming a voucher

Field "subscription_category"

code/value comments
subscription a normal subscription.
lead a subscription with an order but with a price set to zero, or a time-limited subscription without an order.
24h a subscription that is only active 1 day (period type = day and period_length = 1).

Field "subscription_type"

Determines if the subscription is recurring or time-limited, or if the subscription is free.

code/value comments
recurring a normal subscription that is going to be renewed for a new period at end of period.
limited a subscription that will end when the period end is reached.
free a subscription that is payed with payment method "free" or has been created through PAP (without order).

Field "subscription_status"

Determines that current status of the subscription.

code/value comments
activated subscription is currently active and provides access to content for the customer.
cancelled subscription is currently active and provides access to content for the customer, but has been cancelled by customer manually or through servicedesk and will be deactivated at end of period.
deactivated subscription is currently inactive and does not provide access to content for the customer.
pending subscription has been created with a future start date and is not yet activated, does not provide access to content for customer. Will be activated on "subscription_valid_from" date.

Field "deactivation_reason"

code/value comments
campaign_transformation deactivated due to a transformation from campaign to standard subscription has occurred, the new subscription has a corresponding "created_from".
customer_cancel deactivated due to a customer cancellation request
customer_passive_payment deactivated due to customer neglecting to pay for the subscription
subscription_change deactivated due to a subscription change made in PAP.
subscription_downgrade deactivated due to a downgrade of the subscription.
subscription_expired deactivated due to timelimit for limited subscription has passed.
subscription_extension deactivated due to customer has extended their subscription with another subscription at end of period.
subscription_upgrade deactivated due to an upgrade of the subscription.
system deactivated by system.

Field "subscription_share_status"

code/value comments
no_share subscription is not shared to anyone.
shared subscription is currently being shared to another entity.
received subscription is received through an active sharing, it has been accepted and is being used.

Field "product_type"

code/value comments
combination Subscription contains both digital and printed products, can also include epaper
digital_only Subscription only contains digital product
digital_epaper Subscription contains digital products and epaper product
paper_only Subscription only contains printed product
epaper_only Subscription only contains epaper product

Order model

Field "order_category"

code/value comments
campaign Campaign order
standard Standard order
standard_shared Standard order that is being shared
zero_campaign A campaign with a price set to zero but that will transition into a standard subscription.

Field "order_payment_method"

code/value comments
adyen_% Payed with Adyen through Tulo Payments or with separate Adyen account.
billecta_% Invoiced with Billecta
creditcard Creditcard payments by Payex/Swedbank pay or "Visma Pay".
directdebit Direct bank debit, mostly used in Finland
external Payed in another system besides Tulo Payway.
free Free subscription
klarna_payments Klarna payments
invoice Invoice payment managed by external system (not Billecta).

Customer model

Field "customer_type"

code/value comments
active Customer has an active subscription that is owned by the customer.
active+receiver Customer has an active subscription and is also receiving a subscription through a share.
passive Customer has no active subscription of their own but has been a previous subscriber.
passive+receiver Customer has no active subscription of their own but has been a previous subscriber. Is currently receiving a subscription through a share.
lead Customer has never had any subscriptions.

Field "created_from"

code/value comments
admin created in admin.
migration created in migration process.
registration created through registration process.
external_api created through API, for example through Payway Reseller.
create_order_without_account Created from Tulo Shop.