Stripe Billing and Invoicing [FEATURE]

cgsmith commented 1 year ago

Is your feature request related to a problem? Please describe. Billing right now is partly done through Stripe and manually done through Quickbooks. I want to use Stripe for everything billing out of Shipwise. The current integration is fairly broken and just adds credit cards. It also handles the invoicing but doesn't enroll them in the subscription.

Describe the solution you'd like No migrations are necessary as I will be informing the customers of the new subscriptions and terms. They will then choose a plan and be subscribed.

I created a subscription for testing in Stripe under the test mode. Test subscription

Users will need a subscription to use Shipwise
We should leverage Stripe as much as possible for the integration. We can store the info returned in our database if necessary
We will be billing usage amounts to the customer
Customer will be billed a minimum of $70 per month plus $0.10 per order created. Stripe Product is configured to only charge after 100 order entries which is normal. You may see this in testing.

A user will need a subscription to access Shipwise after registration. Related to this #78
If a subscription is cancelled. Shipwise will need to have an endpoint to listen for this and then stop any active integrations
Create usage records on a scheduled basis reference Subscription lifecycle

Additional context Useful documentation:

Stripe Subscription Documentation Stripe Customer Portals

Loom explanation for @bohdan-vorona Video

bohdan-vorona commented 1 year ago

@cgsmith Pushed some latest changes - https://github.com/CGSmith-LLC/shipwise-api/compare/master...feature/stripe-billing-and-invoicing Docs are updated. // FYI

I'm going to finish the webhooks implementation and the {payment/subscription management} via the customer portal.

I added logic for working with Stripe webhooks, but, since we already have similar logic for Shopify, it would be great to combine some parts. I've created https://github.com/CGSmith-LLC/shipwise-api/issues/177 for this. Once, these two branches are merged, I will implement this.

bohdan-vorona commented 1 year ago

Updated SubscriptionService
Implemented the logic with subscription history
Removed some other Stripe logic and values
Upgraded StripeCheckoutSessionCompletedJob

Working on:

Changes for the /subscription page based on the changes for subscription history (active subscription is stored here)
Catching changes on Stripe's subscription side
Subscription cancel webhook

bohdan-vorona commented 1 year ago

@cgsmith

Implemented the /subscription page (screenshot below)
Implemented the ability to get the latest invoice (screenshot below)
Added the ability to use the Customer Portal (screenshot below)

Working on:

Cancel subscription using the Customer Portal
Different switches: from trial to active, pause/resume, failed payment, etc. It's a bit time-consuming to handle these states)

curr-subs

cgsmith commented 1 year ago

Thanks @bohdan-vorona let me review what you currently have. I think you might be adding more of a direct integration instead of leveraging their customer portal.

No problem if you did!

bohdan-vorona commented 1 year ago

Check - Stripe (webhooks + Dashboard):

[x] Trial period starts (by user)
[x] Trial period ends (automatically)
[x] Cancel trial period (by user)
[x] Switching from trial period to "real" subscription
[x] Cancel "real" subscription (by user)
[x] Unpaid "real" subscription (by user)
[x] "Real" subscription update (by user)
[x] Dashboard -> Delete customer
[x] Dashboard -> Delete customer -> Delete subscription via webhook -> Delete subscription on the website
[x] Dashboard -> Delete subscription -> Delete subscription via webhook -> Delete subscription on the website
[x] Dashboard -> Update subscription -> Update subscription via webhook -> Update subscription on the website
[x] Dashboard -> Add subscription -> Add subscription via webhook -> Add subscription on the website
[x] Change plan from monthly to yearly or yearly-monthly
[x] per unit

Check - website:

[x] Pricing table subscription
[x] Invoice
[x] Customer portal
[x] Cron -> Make inactive past-due subscriptions

bohdan-vorona commented 1 year ago

@cgsmith In general, I've finished the main part of Stripe integration. Implemented the following webhooks: _customer.deleted, checkout.session.completed, customer.subscription.created, customer.subscription.trial_willend, customer.subscription.deleted, customer.subscription.updated.

I'm working on usage-based measurement.

Some moments I need help with:

For the moment, to get the current customer I use this mock code:

$customer = Customer::findOne(1); // I find the first customer
$subscriptionService = new SubscriptionService($customer);

How shall I determine the current customer? As I see, in the User model we have such code:

    public function getCustomerId()
    {
        return $this->customer_id;
    }

But also, as I see, one user can have several customers:

    public function getCustomerIds()
    {
        return ArrayHelper::getColumn(
            $this->hasMany('frontend\models\UserCustomer', ['user_id' => 'id'])
                ->select('customer_id')
                ->asArray()
                ->all(),
            'customer_id');
    }

So, shall I use the field customer_id from the user table or ...?

There was old billing logic I used:

        if (!Yii::$app->session->has($module->switchIdentitySessionKey) &&
            !Yii::$app->user->identity->isAdmin &&
            Yii::$app->user->identity->isDirectCustomer()) {
                // code...
        }

I left all these checks for my logic too. Is it correct? It means that I will check the current active subscription only if it's not an admin and is a direct customer and it's not switching between users.