Laravel Cashier Mollie

https://github.com/mollie/laravel-cashier-mollie
Admin
Laravel Cashier provides an expressive, fluent interface to subscriptions using Mollie's billing...
Tokens:103,299
Snippets:751
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Plan model with buildCashierPlan method

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Example Plan model with a buildCashierPlan method that returns a Laravel\Cashier\Plan\Plan. Uses Money and Currency for amount handling and configures first payment details and order item preprocessors.

```php
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Laravel\Cashier\Cashier;
use Laravel\Cashier\Plan\Plan as CashierPlan;
use Money\Currency;
use Money\Money;
use Laravel\Cashier\Order\OrderItemPreprocessorCollection as Preprocessors;

class Plan extends Model
{
    use HasFactory;

    /**
     * Builds a Cashier plan from the current model.
     *
     * @returns \Laravel\Cashier\Plan\Plan
     */
    public function buildCashierPlan(): CashierPlan
    {
        $plan = new CashierPlan($this->name);

        return $plan->setAmount($this->getAmount())
            ->setInterval($this->interval)
            ->setDescription($this->description)
            ->setFirstPaymentMethod(config('cashier.first_payment.method'))
            ->setFirstPaymentAmount($this->getAmount())
            ->setFirstPaymentDescription($this->description)
            ->setFirstPaymentRedirectUrl(route('plans-payment.success', ['plan' => $this->id]))
            ->setFirstPaymentWebhookUrl(Cashier::firstPaymentWebhookUrl())
            ->setOrderItemPreprocessors(Preprocessors::fromArray(config('cashier_plans.defaults.order_item_preprocessors')));
    }

    private function getAmount(): Money
    {
        return new Money($this->price, new Currency($this->currency));
    }
}
```

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

### Create subscription after generic trial

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Creates an actual subscription for a user who is currently in a generic trial period. Use this after the trial ends or when ready to start the subscription.

```php
$user = User::find(1);

$user->newSubscription('main', 'monthly')->create();
```

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

### Example subscription controller

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

A basic controller that creates a subscription for the authenticated user. It checks if the user is already subscribed, creates the subscription, and redirects to Mollie checkout if a new mandate is needed.

```php
namespace App\Http\Controllers;

use Laravel\Cashier\SubscriptionBuilder\RedirectToCheckoutResponse;
use Illuminate\Support\Facades\Auth;

class CreateSubscriptionController extends Controller
{
    /**
     * @param string $plan
     * @return \Illuminate\Http\RedirectResponse
     */
    public function __invoke(string $plan)
    {
        $user = Auth::user();

        $name = ucfirst($plan) . ' membership';

        if(!$user->subscribed($name, $plan)) {

            $result = $user->newSubscription($name, $plan)->create();

            if(is_a($result, RedirectToCheckoutResponse::class)) {
                return $result; // Redirect to Mollie checkout
            }

            return back()->with('status', 'Welcome to the ' . $plan . ' plan');
        }

        return back()->with('status', 'You are already on the ' . $plan . ' plan');
    }
}
```

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

### Install Laravel Cashier Mollie 2.0 via Composer

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/13-upgrade.md

Use this command to install the package after removing the old dependency. The caret constraint allows any 2.x version.

```bash
composer require mollie/laravel-cashier-mollie "^2.0"
```

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

### Check trial status with onTrial

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Checks if the user is within their trial period using either the user instance or the subscription instance. Both examples yield the same result.

```php
if ($user->onTrial('main')) {
    //
}

if ($user->subscription('main')->onTrial()) {
    //
}
```

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

### Query subscriptions with whereActive and whereCancelled scopes

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Queries the database for subscriptions in a specific state using query scopes. The first example retrieves all active subscriptions, and the second retrieves all cancelled subscriptions.

```php
$activeSubscriptions = Subscription::whereActive()->get();

$cancelledSubscriptions = Subscription::whereCancelled()->get();
```

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

### Check subscription to a specific plan with subscribedToPlan

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use `subscribedToPlan` to check if a user's subscription is actively subscribed to a given plan. Example checks the 'main' subscription for the 'monthly' plan.

```php
if ($user->subscribedToPlan('monthly', 'main')) {
    //
}
```

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

### Access credit order and invoice from RefundProcessed event

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/08-refunds.md

Retrieves the automatically generated credit order and invoice from the RefundProcessed event, then shows how to get a Blade view, PDF, or download response for the invoice.

```php
$creditOrder = $refundProcessedEvent->refund->order;
$invoice = $creditOrder->invoice();
$invoice->view(); // get a Blade view
$invoice->pdf(); // get a pdf of the Blade view
$invoice->download(); // get a download response for the pdf
```

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

### Check subscription status with subscribed method

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use `subscribed` to check if a user is subscribed to a given subscription name. This example checks the 'main' subscription.

```php
if ($user->subscribed('main')) {
    //
}
```

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

### Create subscription with trialUntil

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Creates a subscription with a trial period ending at a specific Carbon instance. Use this when you need to set a custom trial end date rather than a fixed number of days.

```php
use Carbon\Carbon;

$user->newSubscription('main', 'monthly')
    ->trialUntil(Carbon::now()->addDays(10))
    ->create();
```

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

### Create a subscription with newSubscription

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Retrieve a billable model instance and call newSubscription with a name and plan. The result is a Subscription if a valid Mollie mandate exists, otherwise a RedirectToCheckoutResponse that redirects to Mollie checkout for the first payment.

```php
use App\Models\User;

$user = User::find(1);

// Make sure to configure the 'premium' plan in config/cashier_plans.php
$result = $user->newSubscription('main', 'premium')->create();
```

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

### Change subscription plan with swap() and swapNextCycle()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Swap a user to a new subscription plan by passing the plan identifier to the `swap` or `swapNextCycle` method. If the user is on trial, the trial period is maintained, and any existing quantity is also maintained.

```php
use App\Models\User;

$user = App\User::find(1);

// Swap right now
$user->subscription('main')->swap('other-plan-id');

// Swap once the current cycle has completed
$user->subscription('main')->swapNextCycle('other-plan-id');
```

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

### swap($planId)

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Swaps the user to a new subscription plan immediately.

```APIDOC
## swap($planId)

### Description
Swaps the user to a new subscription plan immediately.

### Method
swap

### Endpoint
$user->subscription('main')->swap($planId)

### Parameters
#### Path Parameters
- **$planId** (string) - Required - The identifier of the new subscription plan.

### Request Example
```php
$user->subscription('main')->swap('other-plan-id');
```

### Response
No return value specified.
```

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

### Create subscription with trialDays

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Creates a subscription with a trial period while collecting payment method information upfront. The customer is redirected to the Mollie checkout page to make the first payment and register a mandate. If not cancelled before the trial ends, the customer will be charged.

```php
$user = User::find(1);

$user->newSubscription('main', 'monthly')
            ->trialDays(10)
            ->create();
```

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

### Create PlanFactory with default state

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Factory for the Plan model with default state using Faker. Provides random name, description, price, currency, and interval values.

```php
class PlanFactory extends Factory
{
    /**
     * Define the model's default state.
     *
     * @return array<string, mixed>
     */
    public function definition(): array
    {
        return [
            'name' => $this->faker->name,
            'description' => $this->faker->sentence,
            'price' => '10.00',
            'currency' => $this->faker->currencyCode,
            'interval' => $this->faker->randomElement(['month', 'year']),
        ];
    }
}
```

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

### Run cashier:update to publish and run migrations

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/UPDATE_GUIDE.md

Run this Artisan command to publish and run the migrations required for upgrading Cashier Mollie to v2.

```bash
php artisan cashier:update
```

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

### Create plans table schema

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Database schema for the Plan model. Includes columns for name, description, price, currency, interval, and timestamps.

```php
Schema::create('plans', function (Blueprint $table) {
	$table->id();
	$table->string('name');
	$table->string('description');
	$table->string('price');
	$table->string('currency');
	$table->string('interval');
	$table->timestamps();
});
```

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

### Implement ProvidesInvoiceInformation interface

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/01-installation.md

Implement the ProvidesInvoiceInformation interface on your billable model with these methods.

```php
    /**
    * Get the receiver information for the invoice.
    * Typically includes the name and some sort of (E-mail/physical) address.
    *
    * @return array An array of strings
    */
    public function getInvoiceInformation()
    {
        return [$this->name, $this->email];
    }

    /**
    * Get additional information to be displayed on the invoice. Typically a note provided by the customer.
    *
    * @return string|null
    */
    public function getExtraBillingInformation()
    {
        return null;
    }
```

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

### withCoupon

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Applies a coupon when creating a new subscription. The coupon is validated and may throw a CouponException.

```APIDOC
## withCoupon

### Description
Applies a coupon when creating a new subscription. The coupon is validated and may throw a CouponException.

### Method
withCoupon

### Parameters
- **couponCode** (string) - Required - The coupon code to apply.

### Request Example
```php
$user->newSubscription($name, $plan)
    ->withCoupon('your-coupon-code')
    ->create();
```

### Response
No explicit response documented. The method returns the subscription builder instance for chaining.
```

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

### Test PlanRepository implementation

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Test snippet to verify the custom PlanRepository implementation. Creates a plan with name 'test' and resolves the repository to find it.

```php
use Laravel\Cashier\Plan\Contracts\PlanRepository;
use App\Models\Plan;

Plan::factory()->create(["name" => "test"]);
resolve(PlanRepository::class)->find("test");
```

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

### Interact with customer balance using credit, addCredit, hasCredit

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/06-customer.md

Methods to interact with the customer balance directly. Use with care. `credit('EUR')` returns the balance, `addCredit(money(1000, 'EUR'))` adds €10.00, and `hasCredit('EUR')` checks if credit exists. A separate balance is kept per currency.

```php
$credit = $user->credit('EUR');
$user->addCredit(money(1000, 'EUR')); // add €10.00
$user->hasCredit('EUR');
```

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

### Resume a subscription with the resume method

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Resumes a cancelled subscription while the user is still within their grace period. If resumed before the subscription fully expires, the user is not billed immediately; instead, the subscription is reactivated and billing continues on the original cycle.

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

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

### Create user with generic trial

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Creates a user with a generic trial period by setting the trial_ends_at column during registration. Requires a date mutator for trial_ends_at on the model.

```php
$user = User::create([
    // Populate other user properties...
    'trial_ends_at' => now()->addDays(10),
]);
```

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

### Apply coupon when creating subscription with withCoupon

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use `withCoupon` on a new subscription builder to apply a coupon at creation. The coupon is validated and may throw `Laravel\Cashier\Exceptions\CouponException`.

```php
$user->newSubscription($name, $plan)
    ->withCoupon('your-coupon-code')
    ->create();
```

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

### List and download invoices for user orders

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/07-invoices.md

Lists all invoices for the authenticated user by iterating over their orders. Includes a route that downloads the invoice using the downloadInvoice method.

```php
// Your blade view file
<ul class="list-unstyled">
    @foreach(auth()->user()->orders as $order)
    <li>
        
        <a href="/download-invoice/{{ $order->id }}">
            {{ $order->invoice()->id() }} -  {{ $order->invoice()->date() }}
        </a>
    </li>
    @endforeach
</ul>

// routes/web.php
Route::middleware('auth')->get('/download-invoice/{orderId}', function($orderId){

    return (request()->user()->downloadInvoice($orderId));
});
```

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

### Create an advanced refund with RefundItem

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/08-refunds.md

Builds a refund manually with fine-grained control. Creates a RefundItem for shipping costs and adds it to a new refund along with an item from the order, then creates the refund.

```php
use Laravel\Cashier\Refunds\RefundItem;

$shippingCosts = RefundItem::make([
    'owner' => $user,
    'description' => 'Shipping costs',
    'currency' => 'EUR',
    'quantity' => 1,
    'unit_price' => 667, // EUR 6.67
    'tax_percentage' => 21,
]);

$order->newRefund()
    ->addItem(RefundItem::makeFromOrderItem($order->items->first()))
    ->addItem($shippingCosts)
    ->create();
```

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

### Bind PlanRepository to DatabasePlanRepository

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Binds the custom DatabasePlanRepository to the PlanRepository contract in a service provider's register method.

```php
class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind(\Laravel\Cashier\Plan\Contracts\PlanRepository::class, DatabasePlanRepository::class);
    }
}
```

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

### resume()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Resumes a cancelled subscription if the user is still within the grace period.

```APIDOC
## resume()

### Description
Resumes a cancelled subscription if the user is still within the grace period. The subscription is reactivated and the user will be billed on the original billing cycle.

### Method
resume

### Parameters
None

### Request Example
```php
$user->subscription('main')->resume();
```

### Response
No return value specified.
```

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

### Implement DatabasePlanRepository with PlanRepository contract

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Custom implementation of the PlanRepository contract that loads plans from a database. Must return a Laravel\Cashier\Plan\Contracts\Plan instance. The findOrFail method throws PlanNotFoundException when no plan is found.

```php
use App\Models\Plan;
use Laravel\Cashier\Exceptions\PlanNotFoundException;
use Laravel\Cashier\Plan\Contracts\Plan as PlanContract;
use Laravel\Cashier\Plan\Contracts\PlanRepository;

class DatabasePlanRepository implements PlanRepository
{
    public static function find(string $name): PlanContract
    {
        /** @var Plan $plan */
        $plan = Plan::where('name', $name)->firstOrFail();

        // Return a \Laravel\Cashier\Plan\Plan by creating one from the database values
        return $plan->buildCashierPlan();

        // Or if your model implements the contract: \Laravel\Cashier\Plan\Contracts\Plan
        return $plan;
    }

    public static function findOrFail(string $name): PlanContract
    {
        if (($result = self::find($name)) === null) {
            throw new PlanNotFoundException;
        }

        return $result;
    }
}
```

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

### Check if subscription is on trial with onTrial method

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use `onTrial` on a subscription instance to determine if the user is still within their trial period. Useful for displaying trial warnings.

```php
if ($user->subscription('main')->onTrial()) {
    //
}
```

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

### Manage subscription quantity with incrementQuantity(), decrementQuantity(), updateQuantity()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Manage subscription quantity using `incrementQuantity`, `decrementQuantity`, and `updateQuantity` methods. These are useful for per-seat pricing models, allowing you to add or subtract a specified amount or set an exact quantity.

```php
use App\Models\User;

$user = App\User::find(1);

// Increment the subscription quantity by one
$user->subscription('main')->incrementQuantity();

// Add five to the subscription's current quantity...
$user->subscription('main')->incrementQuantity(5);

// Decrement the subscription quantity by one
$user->subscription('main')->decrementQuantity();

// Subtract five to the subscription's current quantity...
$user->subscription('main')->decrementQuantity(5);

// Provide a specific subscription quantity
$user->subscription('main')->updateQuantity(10);
```

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

### Sync subscription plans with php artisan cashier:sync-plans

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Run this command to update scheduled order items to match the new plan configuration after changing plans in config/cashier_plans.php. Note that already scheduled order items are not affected until this command is run.

```bash
php artisan cashier:sync-plans
```

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

### All available Subscription query scopes

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Lists all available query scopes for the Subscription model. Each scope filters subscriptions by a specific state, such as owner, active status, cancellation, trial, grace period, or recurring status.

```php
Subscription::whereOwner($user);

Subscription::whereActive();
Subscription::whereNotActive();

Subscription::whereCancelled();
Subscription::whereNotCancelled();

Subscription::whereOnTrial();
Subscription::whereNotOnTrial();

Subscription::whereOnGracePeriod();
Subscription::whereNotOnGracePeriod();

Subscription::whereRecurring();
Subscription::whereNotRecurring();
```

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

### Set subscription quantity with quantity method

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Invoke the quantity method on the subscription builder before creating the subscription to set a specific quantity for the price.

```php
$user->newSubscription($name, $plan)
    ->quantity(5)
    ->create();
```

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

### Create a one-time charge with ChargeItemBuilder

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/04-charges.md

Creates a one-time charge against a customer using the `charge` method on a billable model. Builds two charge items with `ChargeItemBuilder`, adds them to a new charge, sets a redirect URL, and creates the charge. If the result is a `RedirectToCheckoutResponse`, it is returned; otherwise, redirects back with a status message.

```php
use App\Models\User;

$user = App\User::find(1);

$item = new \Laravel\Cashier\Charge\ChargeItemBuilder($user);
$item->unitPrice(money(100,'EUR')); //1 EUR
$item->description('Test Item 1');
$chargeItem = $item->make();

$item2 = new \Laravel\Cashier\Charge\ChargeItemBuilder($user);
$item2->unitPrice(money(200,'EUR'));
$item2->description('Test Item 2');
$chargeItem2 = $item2->make();

$result = $user->newCharge()
    ->addItem($chargeItem)
    ->addItem($chargeItem2)
    ->setRedirectUrl('https://www.example.com')
    ->create();

if(is_a($result, \Laravel\Cashier\Http\RedirectToCheckoutResponse::class)) {
    return $result;
}

return back()->with('status', 'Thank you.');
```

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

### List orders and invoices including credit invoices

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/08-refunds.md

Lists the billable orders and invoices for a user. The invoices method includes credit invoices.

```php
$user->orders;
$user->orders->invoices(); // includes credit invoices
```

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

### AddBalance constructor signature

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/13-upgrade.md

The new constructor requires a quantity parameter. Update your create() calls to include $quantity.

```php
public function __construct(Model $owner, Money $subtotal, int $quantity, string $description) {...}
```

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

### Run default tests with composer test

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/11-testing.md

Runs the default test suite, which excludes the Mollie integration tests.

```bash
composer test
```

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

### Set Mollie API key in .env

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/01-installation.md

Add the Mollie API key to your .env file. Obtain the key from the Mollie dashboard.

```dotenv
MOLLIE_KEY="test_xxxxxxxxxxx"
```

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

### Configure MOLLIE_KEY in phpunit.xml

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/11-testing.md

Sets the Mollie API test key in phpunit.xml. Obtain this key from the Mollie dashboard after signing up.

```xml
<env name="MOLLIE_KEY" value="YOUR_VALUE_HERE"/>
```

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

### swapNextCycle($planId)

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Swaps the user to a new subscription plan once the current billing cycle has completed.

```APIDOC
## swapNextCycle($planId)

### Description
Swaps the user to a new subscription plan once the current billing cycle has completed.

### Method
swapNextCycle

### Endpoint
$user->subscription('main')->swapNextCycle($planId)

### Parameters
#### Path Parameters
- **$planId** (string) - Required - The identifier of the new subscription plan.

### Request Example
```php
$user->subscription('main')->swapNextCycle('other-plan-id');
```

### Response
No return value specified.
```

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

### Register custom model in AppServiceProvider

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/16-configuration.md

Instruct Cashier to use your custom model by calling the useSubscriptionModel method in the boot method of App\Providers\AppServiceProvider. Repeat the same pattern for other configurable models.

```php
use App\Models\Cashier\Subscription;

/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
    Cashier::useSubscriptionModel(Subscription::class);
    // ... use the same pattern for additional models
}
```

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

### Check generic trial with onGenericTrial

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Checks specifically if the user is within their generic trial period and has not created an actual subscription yet.

```php
if ($user->onGenericTrial()) {
    // User is within their "generic" trial period...
}
```

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

### Update payment method with updatePaymentMethod()->create()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/06-customer.md

Use `updatePaymentMethod` on a billable instance to authorize a new mandate. The customer is redirected to Mollie's checkout for a minimal payment. The amount, redirect URL, and description are configured in `config/cashier.php`. The returned response is typically returned from a controller.

```php
use App\Models\User;

$user = User::find(1);

$response = $user->updatePaymentMethod()->create();

return $response;
```

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

### AddGenericOrderItem constructor signature

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/13-upgrade.md

The new constructor requires a quantity parameter. Update your create() calls to include $quantity.

```php
public function __construct(Model $owner, Money $unitPrice, int $quantity, string $description, int $roundingMode = Money::ROUND_HALF_UP) {...}
```

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

### Subscription::whereOnTrial()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve subscriptions on trial.

```APIDOC
## Subscription::whereOnTrial()

### Description
Query scope to retrieve subscriptions that are currently on trial.

### Method
whereOnTrial

### Parameters
None

### Request Example
```php
Subscription::whereOnTrial();
```

### Response
Returns a query builder instance.
```

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

### Refund an order completely with refundCompletely

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/08-refunds.md

Refunds an order completely by calling the refundCompletely method on the order instance. The order must be paid.

```php
use App\Models\User;

$user = App\User::find(1);

$order = $user->orders->first();
$order->refundCompletely();
```

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

### Implement taxPercentage method on billable model

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Return a numeric value between 0 and 100 with no more than 2 decimal places to set the tax rate for a user's subscriptions.

```php
public function taxPercentage() {
    return 20;
}
```

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

### Subscription::whereOnGracePeriod()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve subscriptions on grace period.

```APIDOC
## Subscription::whereOnGracePeriod()

### Description
Query scope to retrieve subscriptions that are currently in their grace period.

### Method
whereOnGracePeriod

### Parameters
None

### Request Example
```php
Subscription::whereOnGracePeriod();
```

### Response
Returns a query builder instance.
```

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

### Check cancelled subscription status with cancelled()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use the `cancelled` method on the subscription instance to check if the user was once an active subscriber but has cancelled their subscription.

```php
if ($user->subscription('main')->cancelled()) {
    //
}
```

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

### Sync tax percentage to existing subscriptions

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Call syncTaxPercentage on the subscription instance to update existing subscriptions with the current taxPercentage value.

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

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

### Schedule CashierRun command

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/01-installation.md

Schedule the CashierRun command periodically. Increase job frequency when processing lots of orders to avoid Mollie's rate limiter.

```php
use Illuminate\Support\Facades\Schedule;
use Laravel\Cashier\Console\Commands\CashierRun;

Schedule::command(CashierRun::class)
    ->hourly() // run as often as you like (daily, monthly, every minute, ...)
    ->withoutOverlapping(); // make sure to include this
```

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

### Configure PAYMENT_PAID_ID in phpunit.xml

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/11-testing.md

Sets the ID of a successful (paid) payment by the customer. Use a 1000 EUR amount.

```xml
<env name="PAYMENT_PAID_ID" value="YOUR_VALUE_HERE"/>
```

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

### Configure MANDATED_CUSTOMER_DIRECTDEBIT_MANDATE_ID in phpunit.xml

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/11-testing.md

Sets the mandate's ID of the previously mentioned customer in phpunit.xml.

```xml
<env name="MANDATED_CUSTOMER_DIRECTDEBIT_MANDATE_ID" value="YOUR_VALUE_HERE"/>
```

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

### Find invoice or fail with 404

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/07-invoices.md

Uses the findInvoiceOrFail and findInvoiceByOrderIdOrFail methods to show a 404 error page when the invoice is not found. Throws NotFoundHttpException if not found, or AccessDeniedHttpException if the invoice doesn't belong to the user.

```php
$order = $user->orders()->first();

$user->findInvoiceOrFail($order->number);
$user->findInvoiceByOrderIdOrFail($order->id);
```

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

### Add aftercare_webhook_url to cashier.php config

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/UPDATE_GUIDE.md

Add the 'aftercare_webhook_url' key below the 'webhook_url' in your cashier.php config file. The aftercare webhook is called by Mollie on refunds and chargebacks.

```php
/**
     * The default webhook url is called by Mollie on payment status updates. You can use either a relative or
     * absolute url.
     */
    'webhook_url' => 'webhooks/mollie',
    
    /**
     * The default aftercare webhook url is called by Mollie on refunds and chargebacks. You can use either a relative or
     * absolute url.
     */
    'aftercare_webhook_url' => 'webhooks/mollie/aftercare',
```

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

### Check grace period with onGracePeriod()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use the `onGracePeriod` method to determine if a user has cancelled their subscription but is still within the grace period until the subscription fully expires. The `subscribed` method still returns `true` during this time.

```php
if ($user->subscription('main')->onGracePeriod()) {
    //
}
```

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

### syncTaxPercentage

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Method to sync the tax percentage on existing subscriptions.

```APIDOC
## syncTaxPercentage

### Description
Updates the tax value for existing subscriptions with the value returned by the `taxPercentage` method. Call this method on the user's subscription instance after changing the hard-coded tax percentage.

### Method
Method on subscription instance

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```php
$user->subscription('main')->syncTaxPercentage();
```

### Response
No return value specified.
```

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

### Enforce redirect to Mollie checkout with newSubscriptionViaMollieCheckout

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use this method instead of newSubscription to always redirect to Mollie checkout and obtain a new mandate. Ensure the 'premium' plan is configured in config/cashier.php.

```php
// make sure to configure the 'premium' plan in config/cashier.php
$redirect = $user->newSubscriptionViaMollieCheckout('main', 'premium')->create();
```

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

### Retry a failed payment with retryNow()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/14-retry.md

Retrieves a user and their failed order, then calls retryNow() to retry the payment. The order ID is the ID of the failed order.

```php
use App\Models\User;

$user = App\User::find(1);

$order = $user->orders->find(1) // id of the failed order;
$order->retryNow();
```

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

### Override customer locale with getLocale()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/06-customer.md

Implement `getLocale()` on the billable model to override Mollie's default locale detection. A common approach is to add a nullable `locale` field to the user table and return its value. The method should return a string like 'nl_NL'.

```php
class User extends Model
{
    /**
     * @return string
     * @link https://docs.mollie.com/reference/v2/payments-api/create-payment#parameters
     * @example 'nl_NL'
     */
    public function getLocale() {
        return $this->locale;
    }
}
```

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

### onTrial

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Determines if the user is still within their trial period for a given subscription. Useful for displaying trial warnings.

```APIDOC
## onTrial

### Description
Determines if the user is still within their trial period for a given subscription. Useful for displaying trial warnings.

### Method
onTrial

### Parameters
- **subscriptionName** (string) - Required - The name of the subscription to check.

### Request Example
```php
if ($user->subscription('main')->onTrial()) {
    //
}
```

### Response
Returns a boolean indicating whether the subscription is on trial.
```

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

### Configure MANDATED_CUSTOMER_DIRECTDEBIT in phpunit.xml

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/11-testing.md

Sets the ID of a customer with a valid directdebit mandate in phpunit.xml.

```xml
<env name="MANDATED_CUSTOMER_DIRECTDEBIT" value="YOUR_VALUE_HERE"/>
```

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

### Cancel subscription immediately

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Call cancelNow to cancel the subscription immediately, without a grace period.

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

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

### updateQuantity($quantity)

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Sets the subscription quantity to a specific value.

```APIDOC
## updateQuantity($quantity)

### Description
Sets the subscription quantity to a specific value.

### Method
updateQuantity

### Endpoint
$user->subscription('main')->updateQuantity($quantity)

### Parameters
#### Path Parameters
- **$quantity** (int) - Required - The new quantity for the subscription.

### Request Example
```php
$user->subscription('main')->updateQuantity(10);
```

### Response
No return value specified.
```

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

### cancelNow

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Method to immediately cancel a subscription.

```APIDOC
## cancelNow

### Description
Immediately cancels a subscription, without a grace period. The subscription ends immediately.

### Method
Method on subscription instance

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```php
$user->subscription('main')->cancelNow();
```

### Response
No return value specified.
```

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

### Subscription::whereOwner($user)

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve subscriptions for a given owner.

```APIDOC
## Subscription::whereOwner($user)

### Description
Query scope to retrieve subscriptions owned by a specific user.

### Method
whereOwner

### Parameters
- **$user** (mixed) - Required - The user whose subscriptions to retrieve.

### Request Example
```php
Subscription::whereOwner($user);
```

### Response
Returns a query builder instance.
```

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

### Subscription::whereActive()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve active subscriptions.

```APIDOC
## Subscription::whereActive()

### Description
Query scope to retrieve subscriptions that are currently active.

### Method
whereActive

### Parameters
None

### Request Example
```php
$activeSubscriptions = Subscription::whereActive()->get();
```

### Response
Returns a query builder instance.
```

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

### NotFoundHttpException for missing invoice

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/07-invoices.md

Exception thrown when the invoice cannot be found using the findInvoiceOrFail methods.

```php
\Symfony\Component\HttpKernel\Exception\NotFoundHttpException
```

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

### onGracePeriod

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Method to check if a cancelled subscription is still in its grace period.

```APIDOC
## onGracePeriod

### Description
Determines if a user has cancelled their subscription and is still within the grace period (i.e., the subscription has not yet ended).

### Method
Method on subscription instance

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```php
if ($user->subscription('main')->onGracePeriod()) {
    //
}
```

### Response
#### Success Response
Returns a boolean indicating whether the user is on a grace period.
```

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

### redeemCoupon

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Redeems a coupon for an existing subscription. The coupon is validated and applied to the upcoming order. Optionally specify the subscription and whether to revoke other active coupons.

```APIDOC
## redeemCoupon

### Description
Redeems a coupon for an existing subscription. The coupon is validated and applied to the upcoming order. Optionally specify the subscription and whether to revoke other active coupons.

### Method
redeemCoupon

### Parameters
- **couponCode** (string) - Required - The coupon code to redeem.
- **subscriptionName** (string) - Optional - The name of the subscription to apply the coupon to. Defaults to the default subscription.
- **revokeOtherCoupons** (bool) - Optional - Whether to revoke other active redeemed coupons for the subscription. Defaults to true.

### Request Example
```php
$user->redeemCoupon('your-coupon-code');
$user->redeemCoupon('your-coupon-code', 'main');
$user->redeemCoupon('your-coupon-code', 'main', false);
```

### Response
No explicit response documented.
```

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

### Check generic trial with onTrial

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/03-trials.md

Checks if the user is within their generic trial period. Returns true if the current date is not past the value of trial_ends_at.

```php
if ($user->onTrial()) {
    // User is within their trial period...
}
```

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

### subscribedToPlan

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Determines if the user is subscribed to a given plan based on a configured plan. Checks if the subscription is actively subscribed to the specified plan.

```APIDOC
## subscribedToPlan

### Description
Determines if the user is subscribed to a given plan based on a configured plan. Checks if the subscription is actively subscribed to the specified plan.

### Method
subscribedToPlan

### Parameters
- **plan** (string) - Required - The plan identifier to check.
- **subscriptionName** (string) - Required - The name of the subscription to check.

### Request Example
```php
if ($user->subscribedToPlan('monthly', 'main')) {
    //
}
```

### Response
Returns a boolean indicating whether the user is subscribed to the given plan.
```

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

### Route middleware to filter access based on subscription status

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

A middleware class that redirects non-subscribed users to the billing page. Uses the `subscribed` method on the user.

```php
<?php

namespace App\Http\Middleware;

use Closure;

class EnsureUserIsSubscribed
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if ($request->user() && ! $request->user()->subscribed('default')) {
            // This user is not a paying customer...
            return redirect('billing');
        }

        return $next($request);
    }
}
```

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

### Redeem coupon for existing subscription with redeemCoupon

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Use `redeemCoupon` on the billable trait to validate and redeem a coupon, applying it to the upcoming order. Optionally specify the subscription and set `$revokeOtherCoupons` to false to keep other active coupons.

```php
$user->redeemCoupon('your-coupon-code');
```

```php
$user->redeemCoupon('your-coupon-code', 'main');
```

```php
$user->redeemCoupon('your-coupon-code', 'main', false);
```

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

### Configure PAYMENT_FAILED_ID in phpunit.xml

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/11-testing.md

Sets the ID of an unsuccessful (failed) payment by the customer in phpunit.xml.

```xml
<env name="PAYMENT_FAILED_ID" value="YOUR_VALUE_HERE"/>
```

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

### Update payment method with skipBalance()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/06-customer.md

By default, the amount paid during payment method update is added to the customer's balance. Apply `skipBalance()` to prevent this. The response is typically returned from a controller.

```php
$response = $user->updatePaymentMethod()
    ->skipBalance()
    ->create();

return $response;
```

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

### onGracePeriod()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Determines if the user has cancelled their subscription but is still within the grace period until the subscription fully expires.

```APIDOC
## onGracePeriod()

### Description
Determines if the user has cancelled their subscription but is still within the grace period until the subscription fully expires.

### Method
onGracePeriod

### Endpoint
$user->subscription('main')->onGracePeriod()

### Parameters
None

### Request Example
```php
if ($user->subscription('main')->onGracePeriod()) {
    //
}
```

### Response
#### Success Response
- **bool** - Returns `true` if the subscription is on grace period, `false` otherwise.
```

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

### Add required fields to migration

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/01-installation.md

Add these fields to your billable model's migration (typically the default create_users_table migration).

```php
$table->string('mollie_customer_id')->nullable();
$table->string('mollie_mandate_id')->nullable();
$table->decimal('tax_percentage', 6, 4)->default(0); // optional
$table->dateTime('trial_ends_at')->nullable(); // optional
$table->text('extra_billing_information')->nullable(); // optional
```

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

### taxPercentage

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Method to implement on the billable model to specify the tax percentage for a subscription.

```APIDOC
## taxPercentage

### Description
Defines the tax percentage applied to a user's subscription. Implement this method on your billable model to specify a tax rate between 0 and 100 with no more than 2 decimal places.

### Method
Method on billable model

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```php
public function taxPercentage() {
    return 20;
}
```

### Response
#### Success Response
Returns a numeric value between 0 and 100 with no more than 2 decimal places.

#### Response Example
```php
20
```
```

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

### Subscription::whereNotOnGracePeriod()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve subscriptions not on grace period.

```APIDOC
## Subscription::whereNotOnGracePeriod()

### Description
Query scope to retrieve subscriptions that are not in their grace period.

### Method
whereNotOnGracePeriod

### Parameters
None

### Request Example
```php
Subscription::whereNotOnGracePeriod();
```

### Response
Returns a query builder instance.
```

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

### Cancel a subscription

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Call cancel on the subscription to cancel it at the end of the billing cycle. Cashier sets the ends_at column, and the subscribed method returns true until that date.

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

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

### Define a custom Subscription model

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/16-configuration.md

Extend the Laravel\Cashier\Subscription class to create a custom model, optionally specifying a custom table name. Use this when you need custom behavior or want to avoid table name conflicts.

```php
namespace App\Models\Cashier;

use Laravel\Cashier\Subscription as CashierSubscription;

class Subscription extends CashierSubscription
{
    protected $table = 'subscriptions';
}
```

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

### Subscription::whereRecurring()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve recurring subscriptions.

```APIDOC
## Subscription::whereRecurring()

### Description
Query scope to retrieve subscriptions that are recurring.

### Method
whereRecurring

### Parameters
None

### Request Example
```php
Subscription::whereRecurring();
```

### Response
Returns a query builder instance.
```

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

### cancel

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Method to cancel a subscription, allowing the user to continue using the application until the end of the billing cycle.

```APIDOC
## cancel

### Description
Cancels a subscription. Cashier automatically sets the `ends_at` column in the `subscriptions` table, which is used to determine when the `subscribed` method returns `false`. The user remains subscribed until the end of the billing cycle.

### Method
Method on subscription instance

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```php
$user->subscription('main')->cancel();
```

### Response
No return value specified.
```

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

### Subscription::whereCancelled()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve cancelled subscriptions.

```APIDOC
## Subscription::whereCancelled()

### Description
Query scope to retrieve subscriptions that have been cancelled.

### Method
whereCancelled

### Parameters
None

### Request Example
```php
$cancelledSubscriptions = Subscription::whereCancelled()->get();
```

### Response
Returns a query builder instance.
```

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

### incrementQuantity($count = 1)

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Increments the subscription quantity by a specified amount (defaults to 1).

```APIDOC
## incrementQuantity($count = 1)

### Description
Increments the subscription quantity by a specified amount (defaults to 1).

### Method
incrementQuantity

### Endpoint
$user->subscription('main')->incrementQuantity($count)

### Parameters
#### Path Parameters
- **$count** (int) - Optional - The number to increment the quantity by. Defaults to 1.

### Request Example
```php
// Increment by one
$user->subscription('main')->incrementQuantity();

// Increment by five
$user->subscription('main')->incrementQuantity(5);
```

### Response
No return value specified.
```

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

### Subscription::whereNotOnTrial()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve subscriptions not on trial.

```APIDOC
## Subscription::whereNotOnTrial()

### Description
Query scope to retrieve subscriptions that are not on trial.

### Method
whereNotOnTrial

### Parameters
None

### Request Example
```php
Subscription::whereNotOnTrial();
```

### Response
Returns a query builder instance.
```

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

### Subscription::whereNotCancelled()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve non-cancelled subscriptions.

```APIDOC
## Subscription::whereNotCancelled()

### Description
Query scope to retrieve subscriptions that have not been cancelled.

### Method
whereNotCancelled

### Parameters
None

### Request Example
```php
Subscription::whereNotCancelled();
```

### Response
Returns a query builder instance.
```

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

### Find invoice by order id

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/07-invoices.md

Retrieves an invoice using the order id with the findInvoiceByOrderId method.

```php
$user->findInvoiceByOrderId($order->id);
```

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

### Use UUIDs for billable model relationships

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/12-faq.md

Modify the cashier migrations to use UUID fields for the billable model relationships, and set the key type in the Billable model to 'string'.

```php
// Replace this:
$table->unsignedInteger('owner_id');

// By this:
$table->uuid('owner_id');
```

```php
protected $keyType = 'string';
```

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

### Subscription::whereNotActive()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve non-active subscriptions.

```APIDOC
## Subscription::whereNotActive()

### Description
Query scope to retrieve subscriptions that are not active.

### Method
whereNotActive

### Parameters
None

### Request Example
```php
Subscription::whereNotActive();
```

### Response
Returns a query builder instance.
```

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

### Subscription::whereNotRecurring()

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Query scope to retrieve non-recurring subscriptions.

```APIDOC
## Subscription::whereNotRecurring()

### Description
Query scope to retrieve subscriptions that are not recurring.

### Method
whereNotRecurring

### Parameters
None

### Request Example
```php
Subscription::whereNotRecurring();
```

### Response
Returns a query builder instance.
```

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

### Find invoice by order number

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/07-invoices.md

Finds a specific invoice by the order number using the findInvoice method on the billable model.

```php
$order = $user->orders()->first();

$user->findInvoice($order->number);
```

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

### decrementQuantity($count = 1)

Source: https://github.com/mollie/laravel-cashier-mollie/blob/main/docs/02-subscriptions.md

Decrements the subscription quantity by a specified amount (defaults to 1).

```APIDOC
## decrementQuantity($count = 1)

### Description
Decrements the subscription quantity by a specified amount (defaults to 1).

### Method
decrementQuantity

### Endpoint
$user->subscription('main')->decrementQuantity($count)

### Parameters
#### Path Parameters
- **$count** (int) - Optional - The number to decrement the quantity by. Defaults to 1.

### Request Example
```php
// Decrement by one
$user->subscription('main')->decrementQuantity();

// Decrement by five
$user->subscription('main')->decrementQuantity(5);
```

### Response
No return value specified.
```
Tokens:
Raw