Ignaciocunado feat/get reimbursable amount for unused time

src/Subscription.php

@@ -612,6 +612,28 @@ public function getCurrencyAttribute()
         return optional($this->plan())->amount()->getCurrency()->getCode();
     }
 
+    /**
+     * Gets the amount to be refunded for the subscription's unused time.
+     *
+     * @param  \Carbon\Carbon|null  $now
+     * @return \Money\Money
+     */
+    public function getReimburseAmountForUnusedTime(?Carbon $now = null): ?Money
+    {
+        $now = $now ?: now();
+
+        if ($this->onTrial()) {
+            return null;
+        }
+        if (round($this->getCycleLeftAttribute($now), 5) == 0) {
+            return null;
+        }
+
+        return $this->reimbursableAmount()
+            ->negative()
+            ->multiply(sprintf('%.8F', $this->getCycleLeftAttribute($now)));
+    }
+
     /**
      * Handle a failed payment.
      *
@@ -639,7 +661,7 @@ public static function handlePaymentPaid(OrderItem $item)
 
         if ($subscription->ends_at !== null) {
             DB::transaction(function () use ($item, $subscription) {
-                if (! $subscription->scheduled_order_item_id) {
+                if (!$subscription->scheduled_order_item_id) {
                     $item = $subscription->scheduleNewOrderItemAt($subscription->ends_at);
                 }
 

tests/Database/Factories/OrderItemFactory.php

@@ -74,4 +74,11 @@ public function USD()
             'currency' => 'USD',
         ]);
     }
+
+    public function withOrder(): self
+    {
+        return $this->state(fn () => [
+            'order_id' => OrderFactory::new(),
+        ]);
+    }
 }

tests/SubscriptionTest.php

@@ -8,6 +8,7 @@
 use Laravel\Cashier\Cashier;
 use Laravel\Cashier\Events\SubscriptionResumed;
 use Laravel\Cashier\Subscription;
+use Laravel\Cashier\Tests\Database\Factories\OrderFactory;
 use Laravel\Cashier\Tests\Database\Factories\OrderItemFactory;
 use Laravel\Cashier\Tests\Database\Factories\SubscriptionFactory;
 use Laravel\Cashier\Tests\Fixtures\User;
@@ -589,4 +590,52 @@ public function canQueryRecurringSubscriptions()
         $this->assertEquals(1, Subscription::whereRecurring()->count());
         $this->assertEquals(2, Subscription::whereNotRecurring()->count());
     }
+
+    /** @test */
+    public function halfWayThroughSubscriptionReturnsPositiveReimburesmentAmount()
+    {
+        $this->withConfiguredPlans();
+
+        $subscriptionHalfWayThrough = SubscriptionFactory::new()
+            ->has(
+                OrderItemFactory::new(['unit_price' => 100])
+                    ->processed()
+                    ->withOrder()
+                    ->EUR(),
+                'scheduledOrderItem'
+            )
+            ->create([
+                'cycle_started_at' => now()->subDays(20),
+                'cycle_ends_at' => now()->addDays(20),
+            ]);
+
+        $this->assertEquals(
+            money('-50', 'EUR'),
+            $subscriptionHalfWayThrough->getReimburseAmountForUnusedTime()
+        );
+    }
+
+    /** @test */
+    public function nonReimbursableSubscriptionReturnsNoReimbursementAmount()
+    {
+        $this->withConfiguredPlans();
+
+        $nonReimbursable = SubscriptionFactory::new()
+            ->has(
+                OrderItemFactory::new(['unit_price' => 100])
+                    ->processed()
+                    ->withOrder()
+                    ->EUR(),
+                'scheduledOrderItem'
+            )
+            ->create([
+                'cycle_started_at' => now()->subMonth(),
+                'cycle_ends_at' => now()->subDay(),
+            ]);
+
+        $this->assertEquals(
+            null,
+            $nonReimbursable->getReimburseAmountForUnusedTime()
+        );
+    }
 }