Laravel Subscriptions

https://github.com/laravelcm/laravel-subscriptions
Admin
A flexible plans and subscription management system for Laravel, providing tools for SAAS-like...
Tokens:37,217
Snippets:313
Trust Score:7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install laravel-subscriptions package

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/README.md

Install the package via Composer, publish its service provider, and run migrations. This is the initial setup for the laravel-subscriptions package.

```shell
composer require laravelcm/laravel-subscriptions
php artisan vendor:publish --provider="Laravelcm\Subscriptions\SubscriptionServiceProvider"
php artisan migrate
```

--------------------------------

### Non-trivial usage with custom start date and free plan

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Creates a subscription with a custom start date (one day ago) and a free plan. When the plan is free, both ends_at and trial_ends_at are null. The example echoes these properties to show the null values.

```php
$startDate = Carbon::now()->subDay();

$subscription = $user->newPlanSubscription('primary', $freePlan, $startDate);

echo $subscription->ends_at;      // null when $freePlan->isFree()
echo $subscription->trial_ends_at; // null when $freePlan->isFree()
```

--------------------------------

### Basic feature usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Shows how to record usage, get usage, get remainings, check if a feature can be used, and reduce usage. The reduceFeatureUsage call decrements by 1 and floors at 0.

```php
$subscription = $user->planSubscription('main');

$subscription->recordFeatureUsage('listings', 2);
echo $subscription->getFeatureUsage('listings');      // 2
echo $subscription->getFeatureRemainings('listings'); // value - 2
echo $subscription->canUseFeature('listings');        // bool

$subscription->reduceFeatureUsage('listings'); // -1, floors at 0
```

--------------------------------

### Basic Period usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/services-period.md

Creates a 1-month period starting now and reads both boundaries. Demonstrates the use of named arguments and the getStartDate, getEndDate, getInterval, and getIntervalCount methods.

```php
use Carbon\Carbon;
use Laravelcm\Subscriptions\Services\Period;

$period = new Period(interval: 'month', count: 1, start: Carbon::now());

$startsAt = $period->getStartDate(); // today
$endsAt = $period->getEndDate();     // today + 1 month

echo $period->getInterval();        // "month"
echo $period->getIntervalCount();   // 1
```

--------------------------------

### Basic usage of plan() relationship

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-belong-to-plan.md

Shows how to access the plan relationship on a Subscription model instance. The example loads a subscription and then accesses the `plan` property to get the related plan's name and increment its price.

```php
use Laravelcm\Subscriptions\Models\Subscription;

$subscription = Subscription::find(1);

echo $subscription->plan->name;       // loaded via the plan() relation
$subscription->plan->increment('price');
```

--------------------------------

### configurePackage method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/subscription-service-provider.md

Configures the package by setting its name, config file, migrations, and install command.

```php
public function configurePackage(Package $package): void
{
    $package->name('laravel-subscriptions')
        ->hasConfigFile('laravel-subscriptions')
        ->hasMigrations([
            'create_plans_table',
            'create_plan_features_table',
            'create_plan_subscriptions_table',
            'create_plan_subscription_usage_table',
            'remove_unique_slug_on_subscriptions_table',
            'update_unique_keys_on_features_table',
            'remove_cancels_at_from_subscriptions_table',
        ])
        ->hasInstallCommand(function (InstallCommand $command): void {
            $command
                ->publishConfigFile()
                ->publishMigrations()
                ->askToStarRepoOnGitHub('laravelcm/laravel-subscriptions');
        });
}

```

--------------------------------

### Non-trivial Period usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/services-period.md

Starts the invoice period at the end of a trial period, exactly as HasPlanSubscriptions::newPlanSubscription() does. Shows how to chain two Period instances, using the trial's end date as the invoice period's start date.

```php
use Carbon\Carbon;
use Laravelcm\Subscriptions\Services\Period;

$trial = new Period(
    interval: $plan->trial_interval,
    count: $plan->trial_period,
    start: $startDate ?? Carbon::now()
);
$period = new Period(
    interval: $plan->invoice_interval,
    count: $plan->invoice_period,
    start: $trial->getEndDate()
);

$trialEndsAt = $trial->getEndDate();
$invoiceStartsAt = $period->getStartDate();
```

--------------------------------

### Status helpers usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Shows how to use the status helper methods (active, onTrial, canceled, ended) on a subscription retrieved via planSubscription().

```php
$subscription = $user->planSubscription('main');

if ($subscription->active()) {
    $subscription->recordFeatureUsage('listings');
}

echo $subscription->onTrial()  ? 'trial'  : 'not-trial';
echo $subscription->canceled() ? 'canceled' : 'active';
echo $subscription->ended()    ? 'period-over' : 'within-period';
```

--------------------------------

### Example: count subscriptions for a plan

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Counts the number of subscriptions associated with the plan with ID 1.

```php
$subscribersCount = Plan::find(1)->subscriptions()->count();
```

--------------------------------

### Get feature value

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Retrieve the value of a specific feature using the plan instance, the Feature model, or the Subscription model. The example shows three ways to get the value of 'pictures_per_listing'.

```php
use Laravelcm\Subscriptions\Models\Feature;
use Laravelcm\Subscriptions\Models\Subscription;

// Use the plan instance to get feature's value
$amountOfPictures = $plan->getFeatureBySlug('pictures_per_listing')->value;

// Query the feature itself directly
$amountOfPictures = Feature::where('slug', 'pictures_per_listing')->first()->value;

// Get feature value through the subscription instance
$amountOfPictures = Subscription::find(1)->getFeatureValue('pictures_per_listing');
```

--------------------------------

### Non-trivial usage of scopeByPlanId() with additional filters

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-belong-to-plan.md

Combines the `byPlanId` scope with a `where` clause on `ends_at` to get active subscriptions for a VIP plan. This example uses the Subscription model.

```php
use Laravelcm\Subscriptions\Models\Subscription;

$vipSubscriptions = Subscription::byPlanId($vipPlanId)
    ->where('ends_at', '>', Carbon::now())
    ->get();
```

--------------------------------

### Install package via Composer

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Install the laravelcm/laravel-subscriptions package using Composer. Run this command in your terminal to add the package to your project.

```shell
composer require laravelcm/laravel-subscriptions
```

--------------------------------

### activate() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Activates the plan with ID 1 by setting is_active to true.

```php
Plan::find(1)->activate();
```

--------------------------------

### Basic usage of newPlanSubscription

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Creates a new subscription for a user with a given plan. The subscription name is 'main' and the start date defaults to now. Requires a User model instance and a Plan instance.

```php
use Carbon\Carbon;
use Laravelcm\Subscriptions\Models\Plan;
use App\Models\User;

$user = User::find(1);
$plan = Plan::find(1);

$user->newPlanSubscription('main', $plan);
```

--------------------------------

### Create a subscription

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Subscribe a user to a plan using the newPlanSubscription method. The first argument is the subscription title, the second is the plan instance, and an optional third argument can specify a custom start date as a Carbon instance.

```php
use Laravelcm\Subscriptions\Models\Plan;
use App\Models\User;

$user = User::find(1);
$plan = Plan::find(1);

$user->newPlanSubscription('main', $plan);
```

--------------------------------

### scopeByFeatureSlug() basic example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription-usage.md

Finds usage for a feature slug on a specific plan.

```php
$usage = Subscription::find(1)->usage()->byFeatureSlug('listings', $plan->id)->first();
```

--------------------------------

### Get plan details

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Query a plan instance to retrieve its features, subscriptions, and check for free/trial/grace periods. The features and subscriptions are Eloquent relationships, so they can be queried further.

```php
use Laravelcm\Subscriptions\Models\Plan;

$plan = Plan::find(1);

// Get all plan features                
$plan->features;

// Get all plan subscriptions
$plan->subscriptions;

// Check if the plan is free
$plan->isFree();

// Check if the plan has trial period
$plan->hasTrial();

// Check if the plan has grace period
$plan->hasGrace();
```

--------------------------------

### Query scopes usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Demonstrates using the query scopes findEndingPeriod, findEndedTrial, and ofSubscriber on the Subscription model.

```php
use Laravel\Subscriptions\Models\Subscription;

$ending = Subscription::findEndingPeriod(3)->get();
$lateTrials = Subscription::findEndedTrial()->get();
$mySubscriptions = Subscription::ofSubscriber($user)->get();
```

--------------------------------

### Example: retrieve first feature by name

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Finds a plan by ID and retrieves the first feature where the name matches 'listing_title_bold'.

```php
$plan = Plan::find(1);
$features = $plan->features()->where('name', 'listing_title_bold')->first();
```

--------------------------------

### subscribedPlans() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Basic usage: retrieves the user's active plans and counts them. The count reflects the number of distinct active plans.

```php
$plans = $user->subscribedPlans();

echo $plans->count(); // number of distinct active plans
```

--------------------------------

### Subscription boot hooks for creating and deleted events

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Defines the boot method with creating and deleted event hooks. The creating hook sets start and end dates from the plan if missing, and the deleted hook cascades deletion to usage records.

```php
protected static function boot(): void
{
    parent::boot();

    static::creating(function (self $model): void {
        if (! $model->starts_at || ! $model->ends_at) {
            $model->setNewPeriod();
        }
    });

    static::deleted(function (self $subscription): void {
        $subscription->usage()->delete();
    });
}
```

--------------------------------

### Publish resources via artisan vendor:publish

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/subscription-service-provider.md

Command to publish the package's config and migrations after installation.

```shell
php artisan vendor:publish --provider="Laravelcm\Subscriptions\SubscriptionServiceProvider"

```

--------------------------------

### Feature usages() example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-feature.md

Retrieves usage records for the feature where the 'used' count is greater than zero.

```php
$usageRecords = $feature->usages()->where('used', '>', 0)->get();
```

--------------------------------

### newPlanSubscription(string $subscription, Plan $plan, ?Carbon $startDate = null): Subscription

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Creates a new subscription for the given plan, with optional custom start date. Handles trial and invoice periods, and sets free plans to never expire.

```APIDOC
## newPlanSubscription(string $subscription, Plan $plan, ?Carbon $startDate = null): Subscription

### Description
Creates a new subscription for the given plan, with optional custom start date. Handles trial and invoice periods, and sets free plans to never expire.

### Method
newPlanSubscription

### Endpoint
newPlanSubscription(string $subscription, Plan $plan, ?Carbon $startDate = null)

### Parameters
#### Parameters
- **$subscription** (string) - Required - Title/slug-like name of the subscription (e.g. `'main'`, `'primary'`)
- **$plan** (Plan) - Required - The plan being subscribed to
- **$startDate** (?Carbon) - Optional - Custom start date; defaults to `Carbon::now()`

### Return Type
- **Subscription** - The newly created subscription. When the plan `isFree()`, both `ends_at` and `trial_ends_at` are immediately set to `null` (free plans never expire, v1.7.1).

### Behavior
- Trial period runs from `$startDate ?? now()` for `trial_period` × `trial_interval`.
- Invoice period starts at the end of the trial for `invoice_period` × `invoice_interval`.
- Datetimes are derived via the `Period` service.
- The `Subscription` model's own `creating` hook also applies period defaults when dates are absent.

### Examples
Basic:

```php
use Carbon\Carbon;
use Laravelcm\Subscriptions\Models\Plan;
use App\Models\User;

$user = User::find(1);
$plan = Plan::find(1);

$user->newPlanSubscription('main', $plan);
```

Non-trivial — custom start date (optional third argument) and free-plan behavior:

```php
$startDate = Carbon::now()->subDay();

$subscription = $user->newPlanSubscription('primary', $freePlan, $startDate);

echo $subscription->ends_at;      // null when $freePlan->isFree()
echo $subscription->trial_ends_at; // null when $freePlan->isFree()
```

### Throws
None declared. The traits file declares no error conditions; failures surface from the `Period` construction or the database layer.
```

--------------------------------

### setNewPeriod method signature

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Protected helper that sets a new billing period on the subscription. Falls back to plan's invoice interval/period when empty, builds a Period starting from the given start or now, and fills starts_at/ends_at. Called by the creating boot hook, changePlan(), and renew().

```php
protected function setNewPeriod(string $invoice_interval = '', ?int $invoice_period = null, ?Carbon $start = null): self
```

--------------------------------

### Period::getStartDate

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/services-period.md

Returns the resolved start date as a Carbon instance.

```APIDOC
## Period::getStartDate

### Description
Returns the resolved start date as a Carbon instance.

### Method
Public method

### Signature
`public function getStartDate(): Carbon`

### Returns
- **Carbon** - The start date.

### Example
```php
$startsAt = $period->getStartDate();
```
```

--------------------------------

### feature() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription-usage.md

Loads a SubscriptionUsage with its feature relationship and accesses the feature name.

```php
$usage = SubscriptionUsage::with('feature')->find(1);
echo $usage->feature->name;
```

--------------------------------

### subscribedTo() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Basic usage: checks if the user is subscribed to a given plan, and if so, retrieves the first matching subscription.

```php
if ($user->subscribedTo($plan->getKey())) {
    $user->planSubscriptions()->where('plan_id', $plan->getKey())->first();
}
```

--------------------------------

### Subscription Model Scopes Usage

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Shows how to use the query scopes on the Subscription model: byPlanId, ofSubscriber, findEndingTrial, findEndedTrial, findEndingPeriod, and findEndedPeriod. The example includes importing the Subscription model and a User model, then demonstrates each scope with a comment. The ofSubscriber scope expects a User instance.

```php
use Laravelcm\Subscriptions\Models\Subscription;
use App\Models\User;

// Get subscriptions by plan
$subscriptions = Subscription::byPlanId($plan_id)->get();

// Get bookings of the given user
$user = User::find(1);
$bookingsOfSubscriber = Subscription::ofSubscriber($user)->get(); 

// Get subscriptions with trial ending in 3 days
$subscriptions = Subscription::findEndingTrial(3)->get();

// Get subscriptions with ended trial
$subscriptions = Subscription::findEndedTrial()->get();

// Get subscriptions with period ending in 3 days
$subscriptions = Subscription::findEndingPeriod(3)->get();

// Get subscriptions with ended period
$subscriptions = Subscription::findEndedPeriod()->get();
```

--------------------------------

### Period constructor implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/services-period.md

The constructor implementation of the Period class, showing how the start date is resolved and the end date is computed by adding the interval count to the start date.

```php
public function __construct(string $interval = 'month', int $count = 1, ?Carbon $start = null)
{
    $this->interval = $interval;

    if (empty($start)) {
        $this->start = Carbon::now();
    } elseif (! $start instanceof Carbon) {
        $this->start = new Carbon($start);
    } else {
        $this->start = $start;
    }

    $this->period = $count;
    $start = clone $this->start;
    $method = 'add' . ucfirst($this->interval) . 's';
    $this->end = $start->{$method}($this->period);
}
```

--------------------------------

### Usage Example of getAttributeValue

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-translations.md

This example shows how to use getAttributeValue on a Plan model: it returns the localized name for the current locale and delegates non-translatable attributes to the parent.

```php
$plan = Plan::find(1);

echo $plan->getAttributeValue('name');      // localized name
echo $plan->getAttributeValue('is_active'); // delegated to parent (bool)
```

--------------------------------

### expired() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription-usage.md

Iterates over usage records and deletes expired ones.

```php
foreach ($subscription->usage()->get() as $usage) {
    if ($usage->expired()) {
        $usage->delete();
    }
}
```

--------------------------------

### Period::__construct

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/services-period.md

Creates a new Period instance. Accepts an interval string (e.g., 'month'), a count of intervals, and an optional start date. If no start date is provided, the current time is used. The end date is computed by adding the count of intervals to the start date.

```APIDOC
## Period::__construct

### Description
Creates a new Period instance. Accepts an interval string (e.g., 'month'), a count of intervals, and an optional start date. If no start date is provided, the current time is used. The end date is computed by adding the count of intervals to the start date.

### Method
Constructor

### Signature
`public function __construct(string $interval = 'month', int $count = 1, ?Carbon $start = null)`

### Parameters
- **$interval** (string) - Optional - Default: 'month' - Interval key; after upper-casing the first letter and appending 's' it becomes the Carbon method invoked on the start date (e.g., 'month' → addMonths). Use Interval enum values.
- **$count** (int) - Optional - Default: 1 - Number of intervals to add to the start date.
- **$start** (?Carbon) - Optional - Default: null - Start date. If null or empty, uses Carbon::now(). If not a Carbon instance, wraps with new Carbon($start).

### Behavior Details
- If $start is empty, uses Carbon::now().
- If $start is not a Carbon instance, coerces it with new Carbon($start).
- The end date is computed by cloning the start and invoking add<Ucfirst(interval)>s(<count>).

### Example
```php
use Carbon\Carbon;
use Laravelcm\Subscriptions\Services\Period;

$period = new Period(interval: 'month', count: 1, start: Carbon::now());
```
```

--------------------------------

### scopeByFeatureSlug() non-trivial example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription-usage.md

Queries usage with explicit subscription_id and uses the scope to filter by feature slug and plan.

```php
$usage = SubscriptionUsage::query()
    ->where('subscription_id', $subscription->id)
    ->byFeatureSlug('deploy-sites', $plan->id)
    ->first();
```

--------------------------------

### Feature getResetDate() basic usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-feature.md

Fetches a feature by name and calculates its reset date from a given Carbon instance.

```php
use Carbon\Carbon;
use Laravelcm\Subscriptions\Models\Feature;

$feature = Feature::where('name', 'listing_duration_days')->first();

$resetDate = $feature->getResetDate(new Carbon());
```

--------------------------------

### subscription() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription-usage.md

Accesses the subscription's ends_at attribute through the relationship.

```php
$usage->subscription->ends_at;
```

--------------------------------

### Change subscription plan with changePlan

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Changes the subscription plan. If the current and new plans have the same billing frequency, billing dates are retained; otherwise, the subscription adopts the new plan's frequency starting on the change day and clears usage data. A trial period is applied if the new plan has one and the subscription is new.

```php
use Laravelcm\Subscriptions\Models\Plan;
use Laravelcm\Subscriptions\Models\Subscription;

$plan = Plan::find(2);
$subscription = Subscription::find(1);

// Change subscription plan
$subscription->changePlan($plan);
```

--------------------------------

### mergeTranslatable() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-translations.md

Adds 'summary' to the translatable attributes, then retrieves its translations. The method returns void.

```php
$plan->mergeTranslatable(['summary']);
echo $plan->getTranslations('summary'); // now readable as translations
```

--------------------------------

### deactivate() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Deactivates the plan with slug 'legacy' using null-safe operator. Sets is_active to false.

```php
Plan::where('slug', 'legacy')->first()?->deactivate();
```

--------------------------------

### attributesToArray() usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-translations.md

Basic usage: retrieves a Plan model and serializes its attributes to JSON, with the 'name' attribute translated according to the current locale.

```php
$plan = Plan::find(1);

json_encode($plan->attributesToArray()); // serializes "name" via current locale
```

--------------------------------

### Get feature by slug with getFeatureBySlug()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Returns the first feature matching the given slug for the plan, or null if none exists. The method is defined in the Plan model and uses the features() relationship.

```php
public function getFeatureBySlug(string $featureSlug): ?Feature
{
    return $this->features()->where('slug', $featureSlug)->first();
}
```

--------------------------------

### Feature getResetDate() non-trivial usage example

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-feature.md

Used by Subscription::recordFeatureUsage() to set valid_until from the subscription's created_at, aligning the reset period with the billing cycle.

```php
$feature = $plan->getFeatureBySlug('listing_duration_days');
$validUntil = $feature->getResetDate($subscription->created_at);
```

--------------------------------

### Check grace period with hasGrace()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Returns true when both grace_period and grace_interval are set. The example shows checking if the grace period is due soon (7 days or less).

```php
$dueSoon = $plan->hasGrace() && $plan->grace_period <= 7;
```

--------------------------------

### Run migrations

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Execute the package's migrations to create the necessary database tables. Run this after publishing the resources.

```shell
php artisan migrate
```

--------------------------------

### Basic usage of planSubscription

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Fetches the subscription with slug 'main' and checks if it exists before calling active().

```php
$main = $user->planSubscription('main');

if ($main) {
    echo $main->active();
}
```

--------------------------------

### bootHasSlug() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-slug.md

The boot hook registers a creating event that generates a slug on create or update based on the model's SlugOptions. It runs before validation.

```php
protected static function bootHasSlug(): void
{
    // Auto generate slugs early before validation
    static::creating(function (Model $model): void {
        if ($model->exists && $model->getSlugOptions()->generateSlugsOnUpdate) {
            $model->generateSlugOnUpdate();
        } elseif (! $model->exists && $model->getSlugOptions()->generateSlugsOnCreate) {
            $model->generateSlugOnCreate();
        }
    });
}
```

--------------------------------

### Basic usage of planSubscriptions()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Retrieves all subscriptions for a user and iterates over them, echoing the subscription name and plan ID.

```php
$subscriptions = $user->planSubscriptions()->get(); // all of this user's subscriptions

foreach ($subscriptions as $subscription) {
    echo $subscription->name . ' -> plan #' . $subscription->plan_id;
}
```

--------------------------------

### Create a Plan with Interval enum values

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/types.md

Shows how to create a Plan using Interval enum values for invoice_interval and trial_interval. The enum values are strings, so they can be passed directly to the create method.

```php
use Laravelcm\Subscriptions\Interval;
use Laravelcm\Subscriptions\Models\Plan;

$plan = Plan::create([
    'name' => 'Pro',
    'price' => 9.99,
    'invoice_period' => 1,
    'invoice_interval' => Interval::MONTH->value,
    'trial_period' => 15,
    'trial_interval' => Interval::DAY->value,
]);
```

--------------------------------

### Boot hook: cascade delete to features and subscriptions

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Defines a static boot method that registers a 'deleted' event listener. When a plan is deleted, it deletes related features and subscriptions, supporting soft deletes.

```php
protected static function boot(): void
{
    parent::boot();

    static::deleted(function ($plan): void {
        $plan->features()->delete();
        $plan->subscriptions()->delete();
    });
}
```

--------------------------------

### Period::getEndDate

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/services-period.md

Returns the computed end date (start date plus the count of intervals) as a Carbon instance.

```APIDOC
## Period::getEndDate

### Description
Returns the computed end date (start date plus the count of intervals) as a Carbon instance.

### Method
Public method

### Signature
`public function getEndDate(): Carbon`

### Returns
- **Carbon** - The end date.

### Example
```php
$endsAt = $period->getEndDate();
```
```

--------------------------------

### activate() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Sets is_active to true and persists the change. Returns the plan instance for fluent chaining. No parameters.

```php
public function activate(): self
{
    $this->update(['is_active' => true]);

    return $this;
}
```

--------------------------------

### Eager loading plan() to avoid N+1 queries

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-belong-to-plan.md

Demonstrates eager loading the `plan` relationship to avoid N+1 queries. It retrieves subscriptions that are not canceled and iterates over them to output the `invoice_interval` from the related plan.

```php
$subscriptions = Subscription::with('plan')->where('canceled_at', null)->get();

foreach ($subscriptions as $subscription) {
    echo $subscription->plan->invoice_interval;
}
```

--------------------------------

### Create a Plan with features

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Create a new plan and attach multiple features to it. The plan uses the Interval enum for invoice and trial intervals. Features are saved using the saveMany method on the plan's relationship.

```php
use Laravelcm\Subscriptions\Models\Plan;
use Laravelcm\Subscriptions\Models\Feature;
use Laravelcm\Subscriptions\Interval;

$plan = Plan::create([
    'name' => 'Pro',
    'description' => 'Pro plan',
    'price' => 9.99,
    'signup_fee' => 1.99,
    'invoice_period' => 1,
    'invoice_interval' => Interval::MONTH->value,
    'trial_period' => 15,
    'trial_interval' => Interval::DAY->value,
    'sort_order' => 1,
    'currency' => 'USD',
]);

// Create multiple plan features at once
$plan->features()->saveMany([
    new Feature(['name' => 'listings', 'value' => 50, 'sort_order' => 1]),
    new Feature(['name' => 'pictures_per_listing', 'value' => 10, 'sort_order' => 5]),
    new Feature(['name' => 'listing_duration_days', 'value' => 30, 'sort_order' => 10, 'resettable_period' => 1, 'resettable_interval' => 'month']),
    new Feature(['name' => 'listing_title_bold', 'value' => 'Y', 'sort_order' => 15])
]);
```

--------------------------------

### Configure table and model overrides

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/configuration.md

Returns a PHP array with 'tables' and 'models' keys. Custom models must extend the corresponding package model, and table overrides let existing databases be reused under different names.

```php
return [
    'tables' => [
        'plans' => 'billing_plans',
        'features' => 'billing_plan_features',
        'subscriptions' => 'billing_subscriptions',
        'subscription_usage' => 'billing_subscription_usage',
    ],
    'models' => [
        'plan' => App\Models\BillingPlan::class,
        'feature' => App\Models\BillingFeature::class,
        'subscription' => App\Models\BillingSubscription::class,
        'subscription_usage' => App\Models\BillingSubscriptionUsage::class,
    ],
];
```

--------------------------------

### planSubscription method signature

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Returns the first subscription matching the given slug fragment using a LIKE query. Returns null if no match is found.

```php
public function planSubscription(string $subscriptionSlug): ?Subscription
{
    return $this->planSubscriptions()->where('slug', 'like', '%' . $subscriptionSlug . '%')->first();
}
```

--------------------------------

### activate()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Activates the plan by setting is_active to true and persisting the change. Returns the plan instance for fluent chaining.

```APIDOC
## activate()

### Description
Activates the plan by setting `is_active` to `true` and persisting the change. Returns the plan instance for fluent chaining.

### Method
activate

### Signature
`public function activate(): self`

### Parameters
None.

### Return type
`self` — the plan instance (fluent). Sets `is_active` to `true` and persists.

### Example
```php
Plan::find(1)->activate();
```
```

--------------------------------

### Basic slug generation on create

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-slug.md

Creating a Plan auto-generates the slug from the name attribute. No manual slug attribute is needed.

```php
use Laravelcm\Subscriptions\Models\Plan;

$plan = Plan::create(['name' => 'Pro', 'price' => 9.99, 'currency' => 'USD']);

echo $plan->slug; // e.g. "pro" (from name, saved to slug)
```

--------------------------------

### Error handling for feature usage

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Shows how to guard feature usage with canUseFeature before recording, and how to handle the nullable return of reduceFeatureUsage when no usage record exists.

```php
if (! $subscription->canUseFeature('listings')) {
    redirectToUpgrade();
}

$usage = $subscription->reduceFeatureUsage('listings', 5);

if ($usage === null) {
    echo 'No usage record to reduce';
}
```

--------------------------------

### changePlan method signature

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Changes the subscription to a new plan. If billing frequency differs, resets the period and deletes usage; free plans never expire.

```php
public function changePlan(Plan $plan): self
{
    if ($this->plan->invoice_interval !== $plan->invoice_interval || $this->plan->invoice_period !== $plan->invoice_period) {
        $this->setNewPeriod($plan->invoice_interval, $plan->invoice_period);
        $this->usage()->delete();
    }

    $this->fill(['plan_id' => $plan->getKey()]);

    if ($plan->isFree()) {
        $this->fill([
            'ends_at' => null,
            'trial_ends_at' => null,
        ]);
    }

    $this->save();

    return $this;
}
```

--------------------------------

### Error handling with planSubscription

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Guards against the nullable return value. If null, creates a new subscription with newPlanSubscription.

```php
$subscription = $user->planSubscription('primary');

if ($subscription === null) {
    $user->newPlanSubscription('primary', $plan); // no subscription yet
}
```

--------------------------------

### Basic usage of getFeatureBySlug()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Fetches a plan by ID and retrieves the value of a feature using its slug. Requires the Plan model to be imported.

```php
use Laravelcm\Subscriptions\Models\Plan;

$plan = Plan::find(1);
echo $plan->getFeatureBySlug('pictures_per_listing')->value;
```

--------------------------------

### Check if plan is free with isFree()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Returns true when the plan's price is less than or equal to 0.00. The price attribute is cast to float. Use this to conditionally delete subscriptions for free plans.

```php
if ($plan->isFree()) { $plan->subscriptions()->delete(); }
```

--------------------------------

### Class declaration for SubscriptionServiceProvider

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/subscription-service-provider.md

Declares the final SubscriptionServiceProvider class extending PackageServiceProvider with a configurePackage method.

```php
final class SubscriptionServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
}

```

--------------------------------

### Basic usage of scopeByPlanId() on Feature model

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-belong-to-plan.md

Shows how to use the `byPlanId` scope to retrieve all features of a given plan, ordered by `sort_order`. This works on the Feature model which also uses the trait.

```php
use Laravelcm\Subscriptions\Models\Feature;

$features = Feature::byPlanId(3)->orderBy('sort_order')->get();
```

--------------------------------

### planSubscriptions() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

The exact implementation of the planSubscriptions() method, defining a polymorphic one-to-many relation to the Subscription model using the 'subscriber' morph name.

```php
public function planSubscriptions(): MorphMany
{
    return $this->morphMany(
        related: config('laravel-subscriptions.models.subscription'),
        name: 'subscriber',
        type: 'subscriber_type',
        id: 'subscriber_id'
    );
}
```

--------------------------------

### subscribedPlans() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Returns a collection of distinct plans with active subscriptions. Rejects inactive subscriptions before querying the plan model. Uses the plan model configured in 'laravel-subscriptions.models.plan'.

```php
public function subscribedPlans(): Collection
{
    $planIds = $this->planSubscriptions->reject
        ->inactive()
        ->pluck('plan_id')
        ->unique();

    $model = config('laravel-subscriptions.models.plan');

    return $model::whereIn('id', $planIds)->get();
}
```

--------------------------------

### Register provider in test bench

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/subscription-service-provider.md

Registers the SubscriptionServiceProvider in a test bench's getPackageProviders method.

```php
use Laravelcm\Subscriptions\SubscriptionServiceProvider;

protected function getPackageProviders($app): array
{
    return [
        SubscriptionServiceProvider::class,
    ];
}

```

--------------------------------

### Non-trivial query with planSubscriptions()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Queries the relation to find the most recent active subscription by filtering on ends_at and ordering by created_at.

```php
$active = $user->planSubscriptions()
    ->where('ends_at', '>', Carbon::now())
    ->orderByDesc('created_at')
    ->first();
```

--------------------------------

### changePlan basic usage

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Changes the subscription to a plan found by ID.

```php
use Laravelcm\Subscriptions\Models\Plan;

$plan = Plan::find(2);
$subscription->changePlan($plan);
```

--------------------------------

### Trait declaration for HasPlanSubscriptions

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Shows the public methods provided by the trait: planSubscriptions(), activePlanSubscriptions(), planSubscription(), subscribedPlans(), subscribedTo(), and newPlanSubscription().

```php
trait HasPlanSubscriptions
{
    public function planSubscriptions(): MorphMany

    public function activePlanSubscriptions(): Collection

    public function planSubscription(string $subscriptionSlug): ?Subscription

    public function subscribedPlans(): Collection

    public function subscribedTo(int $planId): bool

    public function newPlanSubscription(string $subscription, Plan $plan, ?Carbon $startDate = null): Subscription
}
```

--------------------------------

### Basic usage of getTranslations

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-translations.md

Shows how to retrieve a single translation by key and all translations. When a key is given, the method returns a locale-to-value map; when called with no arguments, it returns an attribute-to-translations map.

```php
$plan = Plan::find(1);

echo $plan->getTranslations('name')['en'] ?? '—';
$all = $plan->getTranslations(); // ['name' => [...], 'description' => [...]]
```

--------------------------------

### Basic usage of activePlanSubscriptions

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Iterates over active subscriptions and echoes each subscription's slug. Operates on the in-memory relation, not a DB query.

```php
foreach ($user->activePlanSubscriptions() as $subscription) {
    echo $subscription->slug;
}
```

--------------------------------

### Canonical configuration file content (config/laravel-subscriptions.php)

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/configuration.md

The complete configuration array for the package, defining the `tables` and `models` mappings. Use this as the default content when publishing the config file. The `tables` keys map logical relation names to physical table names, and the `models` keys map logical model names to model classes.

```php
return [

    'tables' => [
        'plans' => 'plans',
        'features' => 'features',
        'subscriptions' => 'subscriptions',
        'subscription_usage' => 'subscription_usage',
    ],

    'models' => [
        'plan' => Plan::class,
        'feature' => Feature::class,
        'subscription' => Subscription::class,
        'subscription_usage' => SubscriptionUsage::class,
    ],

];
```

--------------------------------

### Check subscription status with active, canceled, ended, onTrial

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Provides alternative methods to check subscription status. Canceled subscriptions with an active trial or future ends_at are considered active.

```php
$user->planSubscription('main')->active();
$user->planSubscription('main')->canceled();
$user->planSubscription('main')->ended();
$user->planSubscription('main')->onTrial();
```

--------------------------------

### changePlan with different billing frequencies

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Shows that changing to a plan with the same billing frequency keeps dates and usage, while a different frequency resets the period and clears usage.

```php
$monthly = Plan::where('slug', 'monthly')->first();

$subscription->changePlan($monthly); // same invoice_interval/invoice_period: dates kept

$yearly = Plan::where('slug', 'yearly')->first();
$subscription->changePlan($yearly); // different frequency: new period from today + usage cleared
```

--------------------------------

### Check trial period with hasTrial()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Returns true when both trial_period and trial_interval are set. Use this to conditionally display the trial period and interval.

```php
if ($plan->hasTrial()) { echo $plan->trial_period . ' ' . $plan->trial_interval; }
```

--------------------------------

### subscribedTo() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Checks if a subscription exists for the given plan ID and is active. Returns true only when the subscription exists and Subscription::active() returns true (active trial or ends_at in the future).

```php
public function subscribedTo(int $planId): bool
{
    $subscription = $this->planSubscriptions()
        ->where('plan_id', $planId)
        ->first();

    return $subscription && $subscription->active();
}
```

--------------------------------

### Plan model class declaration

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Defines the Plan model with traits for sorting, slugs, translations, soft deletes, and factory. Specifies fillable attributes, casts, translatable fields, and sortable configuration.

```php
class Plan extends Model implements Sortable
{
    use HasFactory;
    use HasSlug;
    use HasTranslations;
    use SoftDeletes;
    use SortableTrait;

    protected $fillable = ['slug', 'name', 'description', 'is_active', 'price', 'signup_fee', 'currency', 'trial_period', 'trial_interval', 'invoice_period', 'invoice_interval', 'grace_period', 'grace_interval', 'prorate_day', 'prorate_period', 'prorate_extend_due', 'active_subscribers_limit', 'sort_order'];

    protected $casts = ['is_active' => 'boolean', 'price' => 'float', 'signup_fee' => 'float', 'deleted_at' => 'datetime'];

    public $translatable = ['name', 'description'];

    public array $sortable = ['order_column_name' => 'sort_order'];
}
```

--------------------------------

### reduceFeatureUsage method signature

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Reduces the used count by the given amount, flooring at zero. Returns null when no usage record matches the feature slug and plan id.

```php
public function reduceFeatureUsage(string $featureSlug, int $uses = 1): ?SubscriptionUsage
```

--------------------------------

### cancel(bool $immediately = false)

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Cancels the subscription. If $immediately is true, the subscription ends immediately; otherwise it remains active until the end of the billing period.

```APIDOC
## cancel(bool $immediately = false)

### Description
Cancels the subscription. If `$immediately` is `true`, the subscription ends immediately; otherwise it remains active until the end of the billing period.

### Method
`cancel`

### Signature
```php
public function cancel(bool $immediately = false): self
```

### Parameters
- **$immediately** (bool) - Optional - Default: `false` - When `true`, `ends_at` is also set to the cancellation moment (subscription ends right away); otherwise it stays active until the end of the period.

### Return Type
`self` — the subscription (fluent).

### Examples
```php
$subscription->cancel();      // remains active until period end
$subscription->cancel(true);  // ends immediately
```

### Error Handling
A cancel is idempotent from the model's perspective (no exceptions declared), but combine with status checks in application code:
```php
if ($subscription->active() && ! $subscription->canceled()) {
    $subscription->cancel();
}
```
```

--------------------------------

### cancel method signature

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Cancels the subscription. If $immediately is true, ends_at is set to the cancellation moment; otherwise the subscription remains active until the end of the period.

```php
public function cancel(bool $immediately = false): self
{
    $this->fill(['canceled_at' => Carbon::now()]);

    if ($immediately) {
        $this->fill(['ends_at' => $this->canceled_at]);
    }

    $this->save();

    return $this;
}
```

--------------------------------

### plan() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-belong-to-plan.md

The `plan()` method returns a BelongsTo relationship to the model specified by the `laravel-subscriptions.models.plan` config key. It uses the `plan_id` foreign key and `id` owner key.

```php
public function plan(): BelongsTo
{
    return $this->belongsTo(config('laravel-subscriptions.models.plan'), 'plan_id', 'id', 'plan');
}
```

--------------------------------

### activePlanSubscriptions method signature

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/traits-has-plan-subscriptions.md

Returns the loaded planSubscriptions collection with inactive members removed using reject->inactive().

```php
public function activePlanSubscriptions(): Collection
{
    return $this->planSubscriptions->reject->inactive();
}
```

--------------------------------

### Handle null return from getFeatureBySlug()

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Checks if the feature exists before using it. If not found, creates a new feature with the given name and value.

```php
$feature = $plan->getFeatureBySlug('does-not-exist');

if ($feature === null) {
    $plan->features()->create(['name' => 'pictures_per_listing', 'value' => 10]);
}
```

--------------------------------

### Check subscription status with subscribedTo

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md

Checks if the user is subscribed to a given plan. A subscription is active if it has an active trial or its ends_at is in the future.

```php
$user->subscribedTo($planId);
```

--------------------------------

### onTrial() - Check if subscription is on trial

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Returns true only when trial_ends_at is set and is in the future.

```php
public function onTrial(): bool
{
    return $this->trial_ends_at && Carbon::now()->lt($this->trial_ends_at);
}
```

--------------------------------

### Subscription class declaration with traits, fillable, casts, and translatable

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Defines the Subscription model with traits BelongsToPlan, HasFactory, HasSlug, HasTranslations, and SoftDeletes. Specifies fillable fields, casts for datetime columns, and translatable attributes.

```php
class Subscription extends Model
{
    use BelongsToPlan;
    use HasFactory;
    use HasSlug;
    use HasTranslations;
    use SoftDeletes;

    protected $fillable = ['subscriber_id', 'subscriber_type', 'plan_id', 'slug', 'name', 'description', 'trial_ends_at', 'starts_at', 'ends_at', 'canceled_at'];

    protected $casts = ['subscriber_type' => 'string', 'slug' => 'string', 'trial_ends_at' => 'datetime', 'starts_at' => 'datetime', 'ends_at' => 'datetime', 'canceled_at' => 'datetime', 'deleted_at' => 'datetime'];

    public $translatable = ['name', 'description'];
}
```

--------------------------------

### Catching LogicException when renewing canceled ended subscription

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/errors.md

Shows how to catch the LogicException when calling renew() on a subscription that is canceled and ended. The catch block logs the rejection message.

```php
use LogicException;

$subscription = $user->planSubscription('main');

try {
    $subscription->renew();
} catch (LogicException $e) {
    // Subscription was canceled and its period already ended
    log('Renewal rejected: ' . $e->getMessage());
}
```

--------------------------------

### active() - Check if subscription is active

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-subscription.md

Returns true when the subscription is not ended or is on trial. Canceled subscriptions with an active trial or future ends_at are still considered active.

```php
public function active(): bool
{
    return ! $this->ended() || $this->onTrial();
}
```

--------------------------------

### deactivate() method implementation

Source: https://github.com/laravelcm/laravel-subscriptions/blob/main/_autodocs/api-reference/models-plan.md

Sets is_active to false and persists the change. Returns the plan instance for fluent chaining. No parameters.

```php
public function deactivate(): self
{
    $this->update(['is_active' => false]);

    return $this;
}
```
Tokens:
Raw