Add Billing Portal support

src/Plugin.php

@@ -42,6 +42,7 @@
 use craft\stripe\jobs\SyncData;
 use craft\stripe\models\Settings;
 use craft\stripe\services\Api;
+use craft\stripe\services\BillingPortal;
 use craft\stripe\services\Checkout;
 use craft\stripe\services\Customers;
 use craft\stripe\services\Invoices;
@@ -117,6 +118,7 @@
         return [
             'components' => [
                 'api' => ['class' => Api::class],
+                'billingPortal' => ['class' => BillingPortal::class],
                 'checkout' => ['class' => Checkout::class],
                 'customers' => ['class' => Customers::class],
                 'invoices' => ['class' => Invoices::class],
@@ -156,7 +158,7 @@
                     $this->registerSiteRoutes();
                 }
             }
-//
+
             $projectConfigService = Craft::$app->getProjectConfig();
             $productsService = $this->getProducts();
             $pricesService = $this->getPrices();
@@ -218,6 +220,17 @@
         return $this->get('api');
     }
 
+    /**
+     * Returns the billing portal service
+     *
+     * @return BillingPortal The billing portal service
+     * @throws InvalidConfigException
+     */
+    public function getBillingPortal(): BillingPortal
+    {
+        return $this->get('billingPortal');
+    }
+
     /**
      * Returns the Prices service
      *
@@ -336,27 +349,29 @@
 
     private function registerUserEditScreens(): void
     {
         Event::on(UsersController::class, UsersController::EVENT_DEFINE_EDIT_SCREENS, function(DefineEditUserScreensEvent $event) {
             $event->screens['stripe'] = [
                 'label' => Craft::t('stripe', 'Stripe'),
             ];
         });
 
         Event::on(User::class, User::EVENT_DEFINE_METADATA, function(DefineMetadataEvent $event) {
             $event->metadata[Craft::t('stripe', 'Stripe Customer(s)')] = function() use ($event) {
-                return $event->sender->getStripeCustomers()->reduce(function($carry, $item) {
-                    $carry = is_string($carry) ?: '';
-                    $carry .=
-                        Html::beginTag('div') .
-                        Html::tag(
-                            'a',
-                            $item->data['name'] . ' (' . $item->email . ')' . Html::tag('span', '', ['data-icon' => 'external']),
-                            ['href' => $item->getStripeEditUrl(), 'target' => '_blank']
-                        ) .
-                        Html::endTag('div');
-
-                    return $carry;
-                });
+                return Html::beginTag('div') .
+                    $event->sender->getStripeCustomers()->reduce(function($carry, $item) {
+                        $carry = is_string($carry) ? $carry : '';
+                        $carry .=
+                            Html::beginTag('div') .
+                                Html::tag(
+                                    'a',
+                                    $item->data['name'] . ' (' . $item->stripeId . ')' . Html::tag('span', '', ['data-icon' => 'external']),
+                                    ['href' => $item->getStripeEditUrl(), 'target' => '_blank']
+                                ) .
+                            Html::endTag('div');
+
+                        return $carry;
+                    }) .
+                    Html::endTag('div');
             };
         });
     }
@@ -530,7 +545,7 @@
                 $oldEmail = $userRecord->getOldAttribute('email');
                 $newEmail = $userRecord->getAttribute('email');
                 if ($oldEmail != $newEmail) {
                     $customers = $user->getStripeCustomers();
                     if (!empty($customers)) {
                         $client = $this->getApi()->getClient();
                         foreach ($customers as $customer) {
@@ -545,7 +560,7 @@
         // kick off queue job to sync customer-related data
         Event::on(User::class, User::EVENT_AFTER_SAVE, function(ModelEvent $event) {
             $user = $event->sender;
             if (!empty($user->email) && $user->getStripeCustomers()->isEmpty()) {
                 // search for customer in Stripe by their email address
                 $stripe = $this->getApi()->getClient();
                 $stripeCustomers = $stripe->customers->search(['query' => "email:'{$user->email}'"]);

src/behaviors/StripeCustomerBehavior.php

@@ -8,6 +8,9 @@
 namespace craft\stripe\behaviors;
 
 use craft\elements\User;
+use craft\errors\SiteNotFoundException;
+use craft\helpers\ArrayHelper;
+use craft\helpers\UrlHelper;
 use craft\stripe\elements\Subscription;
 use craft\stripe\models\Customer;
 use craft\stripe\models\PaymentMethod;
@@ -53,6 +56,15 @@ public function attach($owner)
         parent::attach($owner);
     }
 
+    /**
+     * @return Customer|null
+     * @throws InvalidConfigException
+     */
+    public function getStripeCustomer(): ?Customer
+    {
+        return $this->getStripeCustomers()->first();
+    }
+
     /**
      * @return Collection<Customer>
      * @throws InvalidConfigException
@@ -111,4 +123,51 @@ public function getStripePaymentMethods(): Collection
 
         return $this->_paymentMethods ?? new Collection();
     }
+
+    /**
+     * @param string|null $configurationId
+     * @param string|null $returnUrl
+     * @param array $params
+     * @return string|null
+     * @throws InvalidConfigException
+     * @throws SiteNotFoundException
+     */
+    public function getStripeBillingPortalSessionUrl(?string $configurationId = null, ?string $returnUrl = null, array $params = []): ?string
+    {
+        $customer = $this->getStripeCustomer();
+
+        if ($customer === null) {
+            return null;
+        }
+
+        return Plugin::getInstance()->getBillingPortal()->getCustomerBillingPortalSessionUrl($customer, $configurationId, $returnUrl, $params);
+    }
+
+    /**
+     * @param string|null $configurationId
+     * @param string|null $returnUrl
+     * @param array $params
+     * @return string|null
+     * @throws InvalidConfigException
+     * @throws SiteNotFoundException
+     * @throws \Throwable
+     * @throws \yii\base\Exception
+     */
+    public function getStripeBillingPortalSessionPaymentMethodUpdateUrl(?string $configurationId = null, ?string $returnUrl = null, array $params = []): ?string
+    {
+        $customer = $this->getStripeCustomer();
+        if (!$customer) {
+            return null;
+        }
+
+        $returnUrl = $returnUrl ? UrlHelper::siteUrl($returnUrl) : UrlHelper::siteUrl();
+
+        $params = ArrayHelper::merge([
+            'flow_data' => [
+                'type' => 'payment_method_update',
+            ],
+        ], $params);
+
+        return Plugin::getInstance()->getBillingPortal()->getCustomerBillingPortalSessionUrl($customer, $configurationId, $returnUrl, $params);
+    }
 }

src/controllers/CheckoutController.php

@@ -10,6 +10,9 @@
 use Craft;
 use craft\stripe\Plugin;
 use craft\web\Controller;
+use yii\base\InvalidConfigException;
+use yii\web\BadRequestHttpException;
+use yii\web\MethodNotAllowedHttpException;
 use yii\web\Response;
 
 /**
@@ -19,8 +22,13 @@
  */
 class CheckoutController extends Controller
 {
+
     /**
-     *
+     * @return Response
+     * @throws \Throwable
+     * @throws InvalidConfigException
+     * @throws BadRequestHttpException
+     * @throws MethodNotAllowedHttpException
      */
     public function actionCheckout(): Response
     {
@@ -38,12 +46,12 @@
             return $this->asFailure(Craft::t('stripe', 'Please specify the quantity'));
         }
 
-        $successUrl = $request->getBodyParam('successUrl', null);
-        $cancelUrl = $request->getBodyParam('cancelUrl', null);
-        $params = $request->getBodyParam('params', null);
+        $successUrl = $request->getValidatedBodyParam('successUrl', null);
+        $cancelUrl = $request->getValidatedBodyParam('cancelUrl', null);
+        $params = $request->getValidatedBodyParam('params', null);
 
         // start checkout session
         $url = Plugin::getInstance()->getCheckout()->getCheckoutUrl($lineItems, $currentUser, $successUrl, $cancelUrl, $params);
 
         return $this->redirect($url);
     }

src/elements/Subscription.php

@@ -10,6 +10,8 @@
 use Craft;
 use craft\base\Element;
 use craft\elements\User;
+use craft\errors\SiteNotFoundException;
+use craft\helpers\ArrayHelper;
 use craft\helpers\Cp;
 use craft\helpers\Html;
 use craft\helpers\Json;
@@ -22,6 +24,8 @@
 use craft\stripe\Plugin;
 use craft\stripe\records\Subscription as SubscriptionRecord;
 use craft\stripe\web\assets\stripecp\StripeCpAsset;
+use yii\base\Exception;
+use yii\base\InvalidConfigException;
 use DateTime;
 
 /**
@@ -101,7 +105,7 @@ class Subscription extends Element
      * @var DateTime|null
      */
     public ?\DateTime $trialEnd = null;
-    
+
     /**
      * @var array|null
      */
@@ -561,4 +565,68 @@ public function setCustomer(Customer $customer): void
     {
         $this->_customer = $customer;
     }
+
+    /**
+     * Returns the URL to update the subscription in the billing portal.
+     *
+     * @param string|null $returnUrl
+     * @param array $params
+     * @return string|null
+     * @throws \Throwable
+     * @throws SiteNotFoundException
+     * @throws Exception
+     * @throws InvalidConfigException
+     */
+    public function getBillingPortalSessionUpdateUrl(
+        ?string $returnUrl = null,
+        array $params = [],
+    ): ?string {
+        $returnUrl = $returnUrl ? UrlHelper::siteUrl($returnUrl) : UrlHelper::siteUrl();
+        if ($this->status !== self::STATUS_LIVE) {
+            return '';
+        }
+
+        $params = ArrayHelper::merge([
+            'flow_data' => [
+                'type' => 'subscription_update',
+                'subscription_update' => [
+                    'subscription' => $this->stripeId,
+                ],
+            ],
+        ], $params);
+
+        return Plugin::getInstance()->getBillingPortal()->getSessionUrl($this->customerId, null, $returnUrl, $params);
+    }
+
+    /**
+     * Returns the URL to cancel the subscription in the billing portal.
+     *
+     * @param string|null $returnUrl
+     * @param array $params
+     * @return string|null
+     * @throws Exception
+     * @throws InvalidConfigException
+     * @throws SiteNotFoundException
+     * @throws \Throwable
+     */
+    public function getBillingPortalSessionCancelUrl(
+        ?string $returnUrl = null,
+        array $params = [],
+    ): ?string {
+        $returnUrl = $returnUrl ? UrlHelper::siteUrl($returnUrl) : UrlHelper::siteUrl();
+        if ($this->status !== self::STATUS_LIVE) {
+            return '';
+        }
+
+        $params = ArrayHelper::merge([
+            'flow_data' => [
+                'type' => 'subscription_cancel',
+                'subscription_cancel' => [
+                    'subscription' => $this->stripeId,
+                ],
+            ],
+        ], $params);
+
+        return Plugin::getInstance()->getBillingPortal()->getSessionUrl($this->customerId, null, $returnUrl, $params);
+    }
 }

src/events/BillingPortalSessionEvent.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license MIT
+ */
+
+namespace craft\stripe\events;
+
+use yii\base\Event;
+
+/**
+ * Class BillingPortalSessionEvent
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ */
+class BillingPortalSessionEvent extends Event
+{
+    /**
+     * @var array|null Modify the params to use to instantiate the billing portal session with
+     */
+    public ?array $params = null;
+}

src/migrations/Install.php

@@ -124,6 +124,7 @@ public function createTables(): void
             'id' => $this->primaryKey(),
             'stripeId' => $this->string()->notNull(),
             'email' => $this->string()->notNull(),
+            'stripeCreated' => $this->dateTime()->notNull(),
             'data' => $this->json(),
             'dateCreated' => $this->dateTime()->notNull(),
             'dateUpdated' => $this->dateTime()->notNull(),

src/models/Customer.php

@@ -9,6 +9,7 @@
 
 use craft\stripe\base\Model;
 use craft\stripe\Plugin;
+use DateTime;
 
 /**
  * Stripe customer model
@@ -22,6 +23,11 @@ class Customer extends Model
      */
     public ?string $email = null;
 
+    /**
+     * @var ?DateTime The customer creation date in Stripe
+     */
+    public ?DateTime $stripeCreated = null;
+
     /**
      * @var array|string[] Array of params that should be expanded when fetching Customer from the Stripe API
      */
@@ -36,16 +42,4 @@ public function getStripeEditUrl(): string
     {
         return Plugin::getInstance()->stripeBaseUrl . "/customers/{$this->stripeId}";
     }
-
-//    /**
-//     * @inheritdoc
-//     */
-//    protected function defineRules(): array
-//    {
-//        $rules = parent::defineRules();
-//        $rules[] = [['reference'], UniqueValidator::class, 'targetClass' => CustomerRecord::class];
-//        $rules[] = [['gatewayId', 'userId', 'reference', 'data'], 'required'];
-//
-//        return $rules;
-//    }
 }

src/services/Api.php

@@ -112,7 +112,6 @@ public function fetchAllSubscriptions(): array
     public function fetchSubscriptionById(string $id): StripeSubscription
     {
         return $this->fetchOne($id, 'subscriptions', [
-            'status' => 'all',
             'expand' => Subscription::$expandParams,
         ]);
     }