Skip to main content
Installing Subscribd takes four commands. Because it is a private package, you first need to register the repository in your composer.json so Composer knows where to fetch it. After that, the subscribd:install artisan command publishes the config and migrations in one step, and you are ready to start defining plans.
Subscribd requires PHP 8.3+ and Laravel 12+. Confirm your application meets these requirements before proceeding.
1

Register the private repository

Open your project’s composer.json and add the Pixelworxio VCS source to the repositories array. If the key does not already exist, add it at the top level.
composer.json
"repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/pixelworxio/subscribd"
    }
]
Composer reads this entry when resolving the pixelworxio/subscribd package name.
2

Require the package

Run the standard Composer require command. Composer will authenticate against the VCS source and download the package along with its dependencies.
composer require pixelworxio/subscribd
The service provider and the Subscribd and Entitlements facade aliases are registered automatically via Laravel’s package auto-discovery.
3

Run the installer

The subscribd:install command publishes the configuration file and all migration stubs to your project in one step.
php artisan subscribd:install
After the command completes you will find config/subscribd.php in your project. Open it to review the default gateway, currency, and dunning settings before running migrations.
4

Run the migrations

Apply the Subscribd database migrations. The package ships all required migration files that create tables for plans, subscriptions, invoices, payment methods, and more.
php artisan migrate
5

Sync your plans (optional)

If you have already added plan definitions to config/subscribd.php, sync them to the database now. You can re-run this command any time your plan config changes.
php artisan subscribd:plan sync
You can skip this step during initial setup and run it after you have defined your first plan. See the quickstart for a complete plan definition example.

​
What gets installed

After the installer runs, the following files are added to your project:
FilePurpose
config/subscribd.phpGateway credentials, plan definitions, dunning config, billable types
database/migrations/subscribd_*Eleven migration files for all Subscribd tables

​
Next steps

  • Follow the quickstart to make your first model billable and create a subscription.
  • Configure your payment gateway credentials in .env. See Gateway configuration for .env examples for Stripe, PayPal, and Braintree.