Filament Stripe Payment Link

https://github.com/andreia/filament-stripe-payment-link
Admin
A Filament package that provides an action to generate Stripe payment links with a modal interface...
Tokens:3,234
Snippets:30
Trust Score:9.9
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Filament Stripe Payment Link Package

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

Instructions for installing the package using Composer and publishing its configuration file. It also includes an artisan command for installation.

```bash
# Install the package
composer require andreia/filament-stripe-payment-link

# Publish configuration file
php artisan vendor:publish --tag="filament-stripe-payment-link-config"

# Or use the install command
php artisan andreia/filament-stripe-payment-link:install
```

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

### Install Package with Artisan Command

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Installs the Filament Stripe Payment Link package using a dedicated Artisan command. This command may perform additional setup steps beyond just publishing the configuration file.

```bash
php artisan andreia/filament-stripe-payment-link:install
```

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

### Integrate Stripe Payment Link Action in Filament Resource (PHP)

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

Presents a complete example of a Filament resource for an invoice management system, demonstrating the integration of the `GenerateStripeLinkAction` within the form schema. It also shows how to display the payment link in the resource's table view.

```php
<?php

namespace App\Filament\Resources;

use App\Filament\Resources\InvoiceResource\Pages;
use App\Models\Invoice;
use Andreia\FilamentStripePaymentLink\Forms\Actions\GenerateStripeLinkAction;
use Filament\Forms;
use Filament\Forms\Form;
use Filament\Resources\Resource;
use Filament\Tables;
use Filament\Tables\Table;

class InvoiceResource extends Resource
{
    protected static ?string $model = Invoice::class;
    protected static ?string $navigationIcon = 'heroicon-o-document-text';

    public static function form(Form $form): Form
    {
        return $form
            ->schema([
                Forms\Components\Section::make('Customer Information')
                    ->schema([
                        Forms\Components\TextInput::make('customer_name')
                            ->required(),
                        Forms\Components\TextInput::make('customer_email')
                            ->email()
                            ->required(),
                    ])->columns(2),

                Forms\Components\Section::make('Invoice Details')
                    ->schema([
                        Forms\Components\TextInput::make('invoice_number')
                            ->required()
                            ->unique(ignoreRecord: true),
                        Forms\Components\TextInput::make('amount')
                            ->numeric()
                            ->prefix('$')
                            ->required(),
                        Forms\Components\TextInput::make('stripe_payment_link')
                            ->label('Payment Link')
                            ->url()
                            ->columnSpanFull()
                            ->suffixAction(
                                GenerateStripeLinkAction::make('stripe_payment_link')
                            )
                            ->helperText('Click the link icon to generate a Stripe payment link'),
                    ])->columns(2),
            ]);
    }

    public static function table(Table $table): Table
    {
        return $table
            ->columns([
                Tables\Columns\TextColumn::make('invoice_number'),
                Tables\Columns\TextColumn::make('customer_name'),
                Tables\Columns\TextColumn::make('amount')
                    ->money('USD'),
                Tables\Columns\TextColumn::make('stripe_payment_link')
                    ->label('Payment Link')
                    ->url(fn ($record) => $record->stripe_payment_link)
                    ->openUrlInNewTab()
                    ->limit(30),
            ]);
    }
}
```

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

### Install Package via Composer

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Installs the Filament Stripe Payment Link package using Composer, the dependency manager for PHP. This command fetches and installs the latest version of the package and its dependencies.

```bash
composer require andreia/filament-stripe-payment-link
```

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

### Generate Stripe Payment Link Action in Filament

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

Example of integrating the GenerateStripeLinkAction into a Filament resource form. This action opens a modal to collect product details and generates a Stripe payment link.

```php
<?php

namespace App\Filament\Resources\OrderResource;

use Andreia\FilamentStripePaymentLink\Forms\Actions\GenerateStripeLinkAction;
use Filament\Forms;
use Filament\Forms\Form;
use Filament\Resources\Resource;

class OrderResource extends Resource
{
    public static function form(Form $form): Form
    {
        return $form
            ->schema([
                Forms\Components\TextInput::make('customer_name')
                    ->required()
                    ->maxLength(255),

                Forms\Components\TextInput::make('email')
                    ->email()
                    ->required(),

                Forms\Components\TextInput::make('stripe_payment_link')
                    ->label('Payment Link')
                    ->required()
                    ->url()
                    ->suffixAction(
                        GenerateStripeLinkAction::make('stripe_payment_link')
                    ),

                Forms\Components\Select::make('status')
                    ->options([
                        'pending' => 'Pending',
                        'paid' => 'Paid',
                        'cancelled' => 'Cancelled',
                    ])
                    ->default('pending'),
            ]);
    }
}

// When the action is triggered, a modal appears with these fields:
// - product_name (required): Name of the product in Stripe
// - amount (required): Price amount (e.g., 29.99 becomes 2999 cents)
// - currency (required): Three-letter currency code (e.g., USD, EUR, GBP)
//
// On submit, the action:
// 1. Creates a Stripe Product with the given name
// 2. Creates a Stripe Price with the amount and currency
// 3. Creates a Payment Link for the price
// 4. Populates the form field with the payment link URL
// 5. Shows success/error notification

```

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

### Publish Configuration

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Publishes the package's configuration file to your Laravel application. This allows you to customize settings like the action icon and Stripe key location. Alternatively, an artisan command can be used for installation.

```bash
php artisan vendor:publish --tag="filament-stripe-payment-link-config"
```

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

### Stripe API Key Setup for Filament Stripe Payment Link

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

How to set up your Stripe restricted API key in Laravel's services configuration. The key requires write permissions for Products, Prices, and Payment Links.

```php
// config/services.php
return [
    // ... other services

    'stripe' => [
        'payment-link-key' => env('STRIPE_PAYMENT_LINK_KEY'),
    ],
];
```

```dotenv
# .env
STRIPE_PAYMENT_LINK_KEY="rk_live_your_restricted_api_key_here"
```

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

### Configure GenerateStripeLinkAction in Filament Forms (PHP)

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

Demonstrates how to use the GenerateStripeLinkAction to add a Stripe payment link generation button to Filament form fields. It shows basic usage, handling multiple payment link fields, and explains the default configurations for the action.

```php
<?php

use Andreia\FilamentStripePaymentLink\Forms\Actions\GenerateStripeLinkAction;
use Filament\Forms\Components\TextInput;

// Basic usage with default settings
TextInput::make('payment_url')
    ->suffixAction(GenerateStripeLinkAction::make('payment_url'));

// Multiple payment link fields in same form
TextInput::make('one_time_payment_link')
    ->label('One-Time Payment')
    ->suffixAction(GenerateStripeLinkAction::make('one_time_payment'));

TextInput::make('subscription_payment_link')
    ->label('Subscription Payment')
    ->suffixAction(GenerateStripeLinkAction::make('subscription_payment'));

// The action automatically configures:
// - Icon: heroicon-m-link (configurable via config file)
// - Label: "Generate Stripe Payment link"
// - Tooltip: "Click to generate a Stripe payment link"
// - Modal heading: "Generate Stripe Payment Link"
// - Confirmation: disabled by default (configurable via config file)
```

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

### Run Package Tests

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Executes the test suite for the Filament Stripe Payment Link package. This command is used to ensure the package is functioning correctly and to verify any changes made during development.

```bash
composer test
```

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

### Register FilamentStripePaymentLink Service Provider (PHP)

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

Explains how the Filament Stripe Payment Link package is auto-registered via Laravel's package discovery. It also provides instructions for manual service provider registration in `config/app.php` if needed, and lists the assets provided by the service provider.

```php
<?php

// The service provider is auto-registered via composer.json extra.laravel.providers
// Manual registration (if needed):

// config/app.php
'providers' => [
    // ...
    Andreia\FilamentStripePaymentLink\FilamentStripePaymentLinkServiceProvider::class,
],

// The service provider provides:
// - Config file: filament-stripe-payment-link.php
// - Translations: resources/lang/{locale}/filament-stripe-payment-link.php
// - Install command: php artisan andreia/filament-stripe-payment-link:install
```

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

### Configure Filament Stripe Payment Link

Source: https://context7.com/andreia/filament-stripe-payment-link/llms.txt

Configuration options for the Filament Stripe Payment Link package, including the action icon, confirmation behavior, and the location of the Stripe API key in Laravel's configuration.

```php
// config/filament-stripe-payment-link.php
return [
    'action' => [
        'icon' => 'heroicon-m-link',
        'requires-confirmation' => false,
    ],

    'payment-link-key-location' => 'services.stripe.payment-link-key',
];
```

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

### Package Configuration File

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

This is the default content of the published configuration file for the Filament Stripe Payment Link package. It defines default values for the action's icon and whether confirmation is required, as well as the location of the Stripe payment link key in Laravel's service configuration.

```php
return [

    'action' => [
        'icon' => 'heroicon-m-link',
        'requires-confirmation' => false,
    ],

    'payment-link-key-location' => 'services.stripe.payment-link-key',

];
```

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

### Configure Stripe API Key in Laravel Services

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Sets up the Stripe configuration in your Laravel application's `config/services.php` file. This specifies where to find the Stripe payment link key, typically from an environment variable.

```php
'stripe' => [
    'payment-link-key' => env('STRIPE_PAYMENT_LINK_KEY')
],
```

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

### Add Stripe Payment Link Action to Filament Form

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Integrates the `GenerateStripeLinkAction` into a Filament form input field. This allows users to trigger the payment link generation process directly from the form by clicking an icon next to the input.

```php
use Andreia\FilamentStripePaymentLink\GenerateStripeLinkAction;

public static function form(Form $form): Form
{
    return $form
        ->schema([
            TextInput::make('stripe_payment_link')
                ->required()
                ->suffixAction(GenerateStripeLinkAction::make('stripe_payment_link')),
        ]);
}
```

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

### Set Stripe API Key in .env File

Source: https://github.com/andreia/filament-stripe-payment-link/blob/main/README.md

Adds the Stripe secret key to your Laravel project's `.env` file. This key is generated on the Stripe dashboard and is used by the package to authenticate with the Stripe API for creating payment links.

```dotenv
STRIPE_PAYMENT_LINK_KEY="your key here"
```
Tokens:
Raw