@flowfuse/flowfuse/forge/ee/db/controllers/Subscription.js

An open source low-code development platform

module.exports = {
    createSubscription: async function (app, team, subscription, customer, interval) {
        // Check to see if there is an existing subscription for this team.
        const existingSub = await team.getSubscription()
        if (existingSub) {
            // Nick: we need to revisit this path and what scenarios could lead to the team already having a subscription,
            // but we come back to update it with new Stripe details. This has a potential issue if the current subscription
            // is active, but it's going to be overwritten with a new one - leaving the team with two active subscriptions.
            existingSub.customer = customer
            existingSub.subscription = subscription
            if (existingSub.status === app.db.models.Subscription.STATUS.TRIAL) {
                existingSub.trialEndsAt = null
                existingSub.trialStatus = app.db.models.Subscription.TRIAL_STATUS.ENDED
            }
            existingSub.status = app.db.models.Subscription.STATUS.ACTIVE
            existingSub.interval = interval || 'month' // Default to monthly if not specified
            await existingSub.save()

            // This *could* be a trial team that has devices in it. In which case,
            // we need to reconcile the subscription device and instance count
            await app.billing.updateTeamBillingCounts(team)
            return existingSub
        } else {
            // Create the subscription
            const newSubscription = await app.db.models.Subscription.create({
                customer,
                subscription,
                interval
            })
            await newSubscription.setTeam(team)

            return newSubscription
        }
    },
    createUnmanagedSubscription: async function (app, team) {
        const newSubscription = await app.db.models.Subscription.create({
            customer: '',
            subscription: '',
            status: app.db.models.Subscription.STATUS.UNMANAGED
        })
        await newSubscription.setTeam(team)
        return newSubscription
    },
    createTrialSubscription: async function (app, team, trialEndsAt) {
        const newSubscription = await app.db.models.Subscription.create({
            customer: '',
            subscription: '',
            status: app.db.models.Subscription.STATUS.TRIAL,
            trialStatus: app.db.models.Subscription.TRIAL_STATUS.CREATED,
            trialEndsAt
        })
        await newSubscription.setTeam(team)
        return newSubscription
    },
    deleteSubscription: async function (app, team) {
        const subscription = await team.getSubscription()
        if (subscription) {
            await subscription.destroy()
        }
        return null
    },

    freeTrialCreditEnabled: function (app) {
        // Team trial mode overrides team credit
        if (app.settings.get('user:team:trial-mode')) {
            return false
        }
        const creditAmount = app.config.billing?.stripe?.new_customer_free_credit
        if (!creditAmount) {
            return false
        }

        if (creditAmount <= 0) {
            app.log.error('new_customer_free_credit must be set to a cent value greater than zero, disabling free trials.')
            return false
        }

        return true
    },

    // Users are only eligible for the free trial if they're not part of any team
    // newTeamAlreadyCreated is required during subscription creation as the team is created before the subscription
    userEligibleForFreeTrialCredit: async function (app, user, newTeamAlreadyCreated = false) {
        const teamCount = await user.teamCount()

        return teamCount <= (newTeamAlreadyCreated ? 1 : 0)
    }
}