License

The license product type lets you create and manage software licenses that your application can validate against FOSSBilling over the API.

Tip

This is included with FOSSBilling but needs to be enabled from Extensions first.

How It Works

1. Customer purchases a license product
2. FOSSBilling generates a unique license key
3. Your application calls FOSSBilling's API to validate the license
4. FOSSBilling checks the license against your rules (IP, hostname, path, version)
5. Your application grants or denies access based on the response

Setting Up License Products

1. Enable the Extension

Go to Extensions and install "Service License".

2. Create a License Product

When creating the product, configure these options:

Option	Description
plugin	Which validation plugin to use (default: Simple)
prefix	Optional prefix for license keys (e.g., MYAPP-)
length	Length of the generated key (default: 25)
validate_ip	Check the IP address
validate_host	Check the hostname
validate_path	Check the installation path
validate_version	Check the software version

3. Distribute and Validate

Give customers their license key, then have your application validate it using the API.

API Endpoints

Endpoint	Access	Description
/admin/servicelicense/plugin_get_pairs	Admin	List available license plugins
/admin/servicelicense/update	Admin	Update license validation rules
/admin/servicelicense/reset	Admin	Reset license to defaults
/guest/servicelicense/check	Guest	Validate a license

Validating a License

Call /guest/servicelicense/check with these parameters:

• license — the license key
• host — the hostname
• version — the software version
• path — the installation path

Tip

If you disabled validation for certain fields (like host or version), you can send dummy values for them.

Success response:

{
  "result": {
    "licensed_to": "Client Name",
    "created_at": "2025-01-01 12:00:00",
    "expires_at": null,
    "valid": true
  },
  "error": null
}

Error response:

{
  "result": null,
  "error": {
    "message": "Your license key is invalid.",
    "code": 1005
  }
}

Custom License Plugins

You can create your own license generation and validation logic.

Creating a Plugin

Place your plugin in /modules/Servicelicense/Plugin/YourPlugin.php:

class License_YourPlugin
{
    public function generate(array $data): string
    {
        return 'YOUR-KEY-HERE';
    }

    public function validate(\Model_ServiceLicense $service, array $data): array
    {
        if (empty($data['host'])) {
            throw new \LogicException('Host is required', 1020);
        }

        return ['host' => $data['host']];
    }
}

Plugin Requirements

• Class name must be License_PluginName
• File must be PluginName.php in the Plugin/ directory
• Must implement a generate() method
• Optional: implement a validate() method for custom rules

The Simple Plugin (Built-in)

The default Simple plugin generates keys like:

MYAPP-ABCD1-EFGH2-IJKL3-MNOP4

• 25 characters by default
• Optional prefix
• Dashes every 5 characters
• Uppercase letters and digits 1–9

See src/modules/Servicelicense/Plugin/Simple.php for the implementation.