refactor: rename subscription canceled_at column to cancels_at across models, services, and tests

Author: dipaksarkar

database/factories/SubscriptionFactory.php

@@ -97,7 +97,7 @@ public function canceled(): static
         return $this->state([
             'status' => SubscriptionStatus::CANCELED,
             'expires_at' => now(),
-            'canceled_at' => now(),
+            'cancels_at' => now(),
         ]);
     }
 

database/migrations/2019_05_03_000002_create_subscriptions_table.php

@@ -38,7 +38,7 @@ public function up(): void
             $table->timestamp('starts_at')->nullable()->index();
             $table->dateTime('expires_at')->nullable();
             $table->timestamp('ends_at')->nullable();
-            $table->timestamp('canceled_at')->nullable()->index();
+            $table->timestamp('cancels_at')->nullable()->index();
             $table->timestamp('frozen_at')->nullable()->comment('When the subscription was frozen (paused)');
             $table->timestamp('release_at')->nullable()->comment('When the subscription should automatically unfreeze');
             $table->timestamps();

docs/reports/contract-progress.md

@@ -51,7 +51,7 @@ Track fixed-term contract subscription progress. See how many cycles completed,
 ### Active Contracts
 **Type:** Number  
 **Description:** Active subscriptions on this plan (not canceled)  
-**How it's calculated:** Count of subscriptions where status = "active" and canceled_at is null
+**How it's calculated:** Count of subscriptions where status = "active" and cancels_at is null
 
 ### Average Current Cycle
 **Type:** Number  

docs/reports/subscription-lifecycle.md

@@ -70,7 +70,7 @@ Track subscription states and movements over time. See counts of new, active, tr
 ### Grace Period
 **Type:** Number  
 **Description:** Canceled but not yet expired at period end  
-**How it's calculated:** COUNT(canceled_at IS NOT NULL AND expires_at > period end)
+**How it's calculated:** COUNT(cancels_at IS NOT NULL AND expires_at > period end)
 
 ### Reactivations
 **Type:** Number  

src/Actions/Subscription/CancelSubscription.php

@@ -19,7 +19,7 @@ public function execute($subscription)
             $subscription->expires_at = $subscription->trial_ends_at;
         }
 
-        $subscription->canceled_at = now();
+        $subscription->cancels_at = $subscription->expires_at ?? now();
         $subscription->save();
 
         return $subscription;
@@ -34,11 +34,9 @@ public function execute($subscription)
     public function cancelAt($subscription, ?\DateTimeInterface $endsAt)
     {
         if ($endsAt instanceof \DateTimeInterface) {
-            $subscription->expires_at = $endsAt->getTimestamp();
+            $subscription->cancels_at = $endsAt;
         }
 
-        $subscription->status = SubscriptionStatus::CANCELED;
-        $subscription->canceled_at = now();
         $subscription->save();
 
         return $subscription;
@@ -54,8 +52,7 @@ public function cancelNow($subscription)
     {
         $subscription->fill([
             'status' => SubscriptionStatus::CANCELED,
-            'expires_at' => now(),
-            'canceled_at' => now(),
+            'cancels_at' => now(),
         ])->save();
 
         return $subscription;

src/Actions/Subscription/RenewSubscription.php

@@ -175,7 +175,7 @@ protected function executeNoCharge($subscription)
             'expires_at' => $period->getEndDate(),
             'ends_at' => null,
             'trial_ends_at' => null,
-            'canceled_at' => null,
+            'cancels_at' => null,
         ])->save();
 
         if ($isExpired) {

src/Actions/Subscription/ResumeSubscription.php

@@ -32,7 +32,7 @@ public function execute($subscription)
         $subscription->fill([
             'status' => SubscriptionStatus::ACTIVE,
             'expires_at' => $period->getEndDate(),
-            'canceled_at' => null,
+            'cancels_at' => null,
         ])->save();
 
         return $subscription;

src/Actions/Subscription/SwapSubscriptionPlan.php

@@ -56,7 +56,7 @@ public function execute($subscription, $planId, $billing = 'monthly', bool $invo
         );
 
         $subscription->fill([
-            'canceled_at' => null,
+            'cancels_at' => null,
             'billing_interval' => $billingInterval,
             'billing_interval_count' => $billingIntervalCount,
             'total_cycles' => $newPlan->contract_cycles,

src/Models/Subscription.php

@@ -42,7 +42,7 @@ class Subscription extends Model implements ManagesSubscriptions, SubscriptionSt
         'expires_at',
         'ends_at',
         'starts_at',
-        'canceled_at',
+        'cancels_at',
         'frozen_at',
         'release_at',
         'provider',
@@ -70,7 +70,7 @@ class Subscription extends Model implements ManagesSubscriptions, SubscriptionSt
         'expires_at' => 'datetime',
         'ends_at' => 'datetime',
         'starts_at' => 'datetime',
-        'canceled_at' => 'datetime',
+        'cancels_at' => 'datetime',
         'frozen_at' => 'datetime',
         'release_at' => 'datetime',
         'metadata' => 'json',
@@ -603,7 +603,7 @@ public function active(): bool
     public function scopeActive($query)
     {
         $query->where(function ($query) {
-            $query->whereNull('canceled_at')
+            $query->whereNull('cancels_at')
                 ->orWhere(function ($query) {
                     $query->canceledOnGracePeriod();
                 });
@@ -629,17 +629,17 @@ public function scopeRecurring($query)
 
     public function canceled(): bool
     {
-        return ! is_null($this->canceled_at);
+        return ! is_null($this->cancels_at);
     }
 
     public function scopeCanceled($query)
     {
-        $query->whereNotNull('canceled_at');
+        $query->whereNotNull('cancels_at');
     }
 
     public function scopeNotCanceled($query)
     {
-        $query->whereNull('canceled_at');
+        $query->whereNull('cancels_at');
     }
 
     public function ended()
@@ -684,21 +684,19 @@ public function scopeNotOnTrial($query)
 
     public function canceledOnGracePeriod(): bool
     {
-        return $this->canceled_at && $this->expires_at && $this->expires_at->isFuture();
+        return $this->cancels_at && $this->cancels_at->isFuture();
     }
 
     public function scopeCanceledOnGracePeriod($query)
     {
-        $query->whereNotNull('canceled_at')
-            ->whereNotNull('expires_at')
-            ->where('expires_at', '>', Carbon::now());
+        $query->whereNotNull('cancels_at')
+            ->where('cancels_at', '>', Carbon::now());
     }
 
     public function scopeCanceledNotOnGracePeriod($query)
     {
-        $query->whereNotNull('canceled_at')
-            ->whereNotNull('expires_at')
-            ->where('expires_at', '<=', Carbon::now());
+        $query->whereNotNull('cancels_at')
+            ->where('cancels_at', '<=', Carbon::now());
     }
 
     public function onGracePeriod(): bool
@@ -766,7 +764,7 @@ public function toResponse(array $extends = []): array
             'expires_at' => $this->serializeDate($this->expires_at),
             'ends_at' => $this->serializeDate($this->ends_at),
             'starts_at' => $this->serializeDate($this->starts_at),
-            'canceled_at' => $this->serializeDate($this->canceled_at),
+            'cancels_at' => $this->serializeDate($this->cancels_at),
             'frozen_at' => $this->serializeDate($this->frozen_at),
             'release_at' => $this->serializeDate($this->release_at),
             'provider' => $this->provider,

src/Models/User.php

@@ -239,7 +239,7 @@ public function scopeOnlyPlan($query, string $type = 'month'): Builder
     {
         return $query->whereHas('subscriptions', function ($q) use ($type) {
             $q->active()
-                ->whereNull('canceled_at')
+                ->whereNull('cancels_at')
                 ->whereHas('plan', function ($q) use ($type) {
                     $q->whereInterval($type)
                         ->where('price', '<>', 0);
@@ -253,7 +253,7 @@ public function scopeOnlyPlan($query, string $type = 'month'): Builder
     public function scopeOnlyRolling($query): Builder
     {
         return $query->whereHas('subscriptions', function ($q) {
-            $q->active()->whereNull('canceled_at');
+            $q->active()->whereNull('cancels_at');
         });
     }
 
@@ -263,7 +263,7 @@ public function scopeOnlyRolling($query): Builder
     public function scopeOnlyEnds($query): Builder
     {
         return $query->whereHas('subscriptions', function ($q) {
-            $q->active()->whereNotNull('canceled_at');
+            $q->active()->whereNotNull('cancels_at');
         });
     }