Paymenter

https://github.com/paymenter/paymenter
Admin
Paymenter is an open-source billing platform tailored for hosting companies, designed to automate...
Tokens:269,618
Snippets:1,921
Trust Score:6.9
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### installed()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

Called when the extension is installed for the first time. Override to run one-time setup.

```APIDOC
## installed()

### Description
Called when the extension is installed for the first time. If the extension type is server or gateway, it will be called when the first server or gateway is created.

### Method
installed

### Signature
```php
public function installed() {}
```

### Return
- **void**

### Behavior
Override to run one-time setup. Invoked by `app:extension:install` (`app/Console/Commands/Extension/Install.php`) when a new extension is uploaded.
```

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

### installed() - Called on first install

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

Override to run one-time setup. Invoked by app:extension:install (app/Console/Commands/Extension/Install.php) when a new extension is uploaded.

```php
/**
 * Called when the extension is installed for the first time
 * If the extension type is server or gateway, it will be called when the first server or gateway is created
 *
 * @return void
 */
public function installed() {}
```

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

### Example usage of Settings class

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

Usage example showing how to call tax, getSetting, getTelemetry, and validateOrCreateVapidKeys.

```php
use App\Classes\Settings;

$taxRate = Settings::tax($user);          // TaxRate or 0
$company = Settings::getSetting('company_name');
$t = Settings::getTelemetry();            // ['uuid' => ..., 'hour' => ..., 'minute' => ...]
if (!Settings::validateOrCreateVapidKeys()) {
    // Web Push could not be set up
}
```

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

### GET /extensions/paypal/setup-agreement

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Setup agreement endpoint for PayPal payment provider. It is used to initiate the setup of a payment agreement. Requires web and auth middleware.

```APIDOC
## [GET] /extensions/paypal/setup-agreement

### Description
Setup agreement endpoint for PayPal payment provider. It is used to initiate the setup of a payment agreement. Requires web and auth middleware.

### Method
GET

### Endpoint
/extensions/paypal/setup-agreement

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
{}

### Response
#### Success Response (200)
- **status** (string) - Success status

#### Response Example
{
  "status": "success"
}
```

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

### Paymenter artisan commands for setup

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/console.md

Run these artisan commands to initialize the application, create a user, change a setting, create an extension, and set up cron jobs. The commands are executed in sequence as part of the setup workflow.

```bash
php artisan app:init "My Hosting Co" https://billing.example.com
php artisan app:user:create John Doe john@example.com secret123
php artisan app:settings:change company_name
php artisan app:extension:create mygateway gateway
php artisan app:cron-job
```

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

### Settings definition example

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

Example of a settings definition entry extracted from settings(). Shows the descriptor array structure with name, label, type, override, and default.

```php
[
    'name' => 'company_name',
    'label' => 'Company Name',
    'type' => 'text',
    'override' => 'app.name',
    'default' => 'Paymenter',
],
```

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

### GET /extensions/stripe/setup-agreement

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Setup agreement endpoint for Stripe payment provider. It is used to initiate the setup of a payment agreement. Requires web and auth middleware.

```APIDOC
## [GET] /extensions/stripe/setup-agreement

### Description
Setup agreement endpoint for Stripe payment provider. It is used to initiate the setup of a payment agreement. Requires web and auth middleware.

### Method
GET

### Endpoint
/extensions/stripe/setup-agreement

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
{}

### Response
#### Success Response (200)
- **status** (string) - Success status

#### Response Example
{
  "status": "success"
}
```

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

### Discount and formatting example

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/price.md

Shows how to apply a discount and check for discounts, formatted total output, and availability in the current currency.

```php
$price = new Price(['price' => 100.0, 'currency' => $currency]);
$price->setDiscount(20);                       // $price->discount === 20
if ($price->hasDiscount()) {
    echo $price->formatted->total;             // prefix + formatted total + suffix
}
if (!$price->available) {
    // no price in this currency
}
```

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

### Queue a job with CreateJob::dispatch

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/jobs.md

Example of dispatching a job. Shows how to queue CreateJob with a service instance, optionally disabling the notification by passing sendNotification: false.

```php
use App\Jobs\Server\CreateJob;
use App\Models\Service;

$service = Service::findOrFail($id);
CreateJob::dispatch($service);                 // notify user
// or
CreateJob::dispatch($service, sendNotification: false);
```

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

### Extension usage example: listening to GeneratePdf

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/pdf.md

Shows how to listen to the GeneratePdf event from boot() to provide a custom PDF. Uses setPdfFromPath to set the PDF path and file name.

```php
use App\Events\Invoice\GeneratePdf;
use Illuminate\Support\Facades\Event;

Event::listen(GeneratePdf::class, function (GeneratePdf $event) {
    $path = generateCustomInvoicePdf($event->invoice);
    $event->setPdfFromPath($path, 'invoice.pdf');
});
```

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

### GET /api/v1/admin/users

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Example of authenticating and listing admin users via the Admin API.

```APIDOC
## [GET] /api/v1/admin/users

### Description
Retrieves a list of admin users with optional filtering, sorting, and includes. Requires a valid bearer token.

### Method
GET

### Endpoint
/api/v1/admin/users

### Parameters
#### Query Parameters
- **per_page** (int) - Optional - Page size, default 15
- **page** (int) - Optional - Page number
- **filter[<field>]** (mixed) - Optional - Allowed filters per resource
- **sort[<field>]** (string) - Optional - Allowed sorts per resource
- **include** (string) - Optional - Comma-separated list of relationships to include, checked against api_key_permissions

### Request Example
```bash
curl -s https://billing.example.com/api/v1/admin/users?include=role \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Accept: application/vnd.api+json'
```

### Response
#### Success Response (200)
- **data** (array) - List of resources
- **meta** (object) - Pagination metadata: current_page, from, last_page, per_page, to, total
- **relationships** (object) - Present when includes are granted
- **included** (array) - Included related resources when includes are granted

#### Response Example
```json
{
  "data": [],
  "meta": {
    "current_page": 1,
    "from": null,
    "last_page": 1,
    "per_page": 15,
    "to": null,
    "total": 0
  }
}
```

### Error Handling
- **401** - Missing or invalid bearer token
- **403** - Type/IP/permission rejection
- **404** - Not found
- **422** - Validation errors
```

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

### GET /

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

The home page route, rendered by the Home Livewire component. It is publicly accessible and serves as the landing page.

```APIDOC
## GET /

### Description
The home page route, rendered by the Home Livewire component. It is publicly accessible and serves as the landing page.

### Method
GET

### Endpoint
/

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Home Livewire component.

#### Response Example
(HTML content)
```

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

### Price instantiation with tax

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/price.md

Creates a Price instance with a price, setup fee, and currency, applying exclusive tax and a tax value from Settings::tax($user).

```php
use App\Classes\Price;
use App\Classes\Settings;

$price = new Price([
    'price' => 9.99,
    'setup_fee' => 0,
    'currency' => $currency,                  // App\Models\Currency
], apply_exclusive_tax: true, tax: Settings::tax($user));
```

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

### GET /api/v1/admin/{resource}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Lists all resources of a given type.

```APIDOC
## GET /api/v1/admin/{resource}

### Description
Lists all resources of the given type. Requires the `admin.<resource>.view` permission.

### Method
GET

### Endpoint
/api/v1/admin/{resource}

### Parameters
#### Path Parameters
- **resource** (string) - Required - Resource name (e.g., `users`, `products`, `services`).

#### Query Parameters
- **include** (string) - Optional - Comma-separated list of related resources to include; filtered by permissions.

### Response
#### Success Response (200)
- **data** (array) - List of resource objects.

#### Response Example
{
  "data": []
}

```

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

### get()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/cart.md

Static method to retrieve the cart with per-request memoization.

```APIDOC
## get()

### Description
Returns the cart for the current request, memoized per request using `once()`. This avoids repeated database queries within the same request lifecycle.

### Method
`public static function get()`

### Return
- **Type:** `App\Models\Cart`
- **Description:** The cart instance, memoized per request.

### Example
```php
$cart = Cart::get();
```
```

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

### React to a paid invoice from an extension

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/events.md

Example of listening to the Invoice\Paid event to perform custom actions when an invoice is paid, such as provisioning add-ons or crediting commissions.

```php
use App\Events\Invoice\Paid;
use Illuminate\Support\Facades\Event;

Event::listen(Paid::class, function (Paid $event) {
    $invoice = $event->invoice;
    // e.g. provision add-ons, credit a commission, ...
});
```

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

### GET /register

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the registration page for new users. Accessible only to guests.

```APIDOC
## GET /register

### Description
Displays the registration page for new users. Accessible only to guests.

### Method
GET

### Endpoint
/register

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Auth\Register Livewire component.
```

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

### Gateway stub pay() implementation

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/gateway.md

Example stub implementation of the pay() method that returns an empty string. This is the default template used when creating new gateway extensions.

```php
/**
 * Return a view or a url to redirect to
 *
 * @param Invoice $invoice
 * @param float $total
 * @return string
 */
public function pay(Invoice $invoice, $total)
{
    return '';
}
```

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

### GET /products/{category:slug}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the list of products in a given category. Accessible to users with the checkout middleware.

```APIDOC
## GET /products/{category:slug}

### Description
Displays the list of products in a given category. Accessible to users with the checkout middleware.

### Method
GET

### Endpoint
/products/{category:slug}

### Parameters
#### Path Parameters
- **category:slug** (string) - Required - The slug of the category.

### Response
#### Success Response (200)
- HTML page rendered by the Products\Index Livewire component.
```

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

### Programmatic login/logout example

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/actions.md

Programmatic login and logout using the action classes. The login call with remember: true sets a 30-day remember cookie.

```php
use App\Actions\Auth\Login;
use App\Actions\Auth\Logout;

app(Login::class)->execute($user, remember: true);   // establishes session + remember cookie
// ...
app(Logout::class)->execute();
```

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

### GET /products/{category:slug}/{product:slug}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the details of a specific product. Accessible to users with the checkout middleware.

```APIDOC
## GET /products/{category:slug}/{product:slug}

### Description
Displays the details of a specific product. Accessible to users with the checkout middleware.

### Method
GET

### Endpoint
/products/{category:slug}/{product:slug}

### Parameters
#### Path Parameters
- **category:slug** (string) - Required - The slug of the category.
- **product:slug** (string) - Required - The slug of the product.

### Response
#### Success Response (200)
- HTML page rendered by the Products\Show Livewire component.
```

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

### config($key) - Get a configuration value

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

Returns the value from $this->config[$key] or null when missing. If $this->config is empty, it lazily resolves settings from the database: for Gateway/Server extensions it queries App\Models\Gateway or App\Models\Server (extensions table rows filtered by type) for the row matching extension = <class basename>, then plucks settings (morphMany App\Models\Setting) into a key => value map; other extension types query the plain App\Models\Extension model instead.

```php
/**
 * Get a configuration value
 *
 * @param  string  $key
 * @return mixed
 */
public function config($key)
```

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

### GET /services/{service}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the details of a specific service. Requires authentication, email verification, and the 'view' ability on the service.

```APIDOC
## GET /services/{service}

### Description
Displays the details of a specific service. Requires authentication, email verification, and the 'view' ability on the service.

### Method
GET

### Endpoint
/services/{service}

### Parameters
#### Path Parameters
- **service** (string) - Required - The service ID or model binding.

### Response
#### Success Response (200)
- HTML page rendered by the Services\Show Livewire component.
```

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

### GET /services

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the list of services for the authenticated user. Requires authentication and email verification.

```APIDOC
## GET /services

### Description
Displays the list of services for the authenticated user. Requires authentication and email verification.

### Method
GET

### Endpoint
/services

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Services\Index Livewire component.
```

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

### GET /tickets/create

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the form to create a new support ticket. Requires authentication and email verification.

```APIDOC
## GET /tickets/create

### Description
Displays the form to create a new support ticket. Requires authentication and email verification.

### Method
GET

### Endpoint
/tickets/create

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Tickets\Create Livewire component.
```

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

### Get setting by key: Settings::getSetting($key)

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

Returns the setting descriptor for the given key, with its value resolved from the database. The value falls back to the default if not set.

```php
public static function getSetting($key)
```

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

### Calling admin API with includes using curl

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/http-layer.md

Example curl command to call the admin API with includes and filters. It uses an API key for authorization and requests services with user and product includes, filtering by active status.

```bash
curl -H "Authorization: Bearer $API_KEY" \
  "https://billing.example.com/api/v1/admin/services?include=user,product&filter[status]=active"
```

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

### Handle empty gateways from ExtensionHelper::getCheckoutGateways

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension-helper.md

Wrap optional calls to getCheckoutGateways so the checkout keeps working. If the returned array is empty, no gateway accepts the currency/type, so surface an unavailable price. The example shows a call with 'invoice' as the type; real callers include 'cart', 'credits', and 'invoice'.

```php
$gateways = ExtensionHelper::getCheckoutGateways($total, $currency, 'invoice', $items); // example; real callers: 'cart', 'credits', 'invoice'
if (empty($gateways)) {
    // no gateway accepts this currency/type — surface an unavailable price
}
```

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

### GET /services/{service}/upgrade

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the upgrade page for a specific service. Requires authentication, email verification, and the 'view' ability on the service.

```APIDOC
## GET /services/{service}/upgrade

### Description
Displays the upgrade page for a specific service. Requires authentication, email verification, and the 'view' ability on the service.

### Method
GET

### Endpoint
/services/{service}/upgrade

### Parameters
#### Path Parameters
- **service** (string) - Required - The service ID or model binding.

### Response
#### Success Response (200)
- HTML page rendered by the Services\Upgrade Livewire component.
```

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

### Usage example: processing a paid invoice

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/services.md

Shows how to use ProcessPaidInvoiceService to process a paid invoice, as done by observers. It renews services, completes upgrades, or credits the user.

```php
use App\Models\Invoice;
use App\Services\Invoice\ProcessPaidInvoiceService;

app(ProcessPaidInvoiceService::class)->handle($invoice);
// - renews services, completes upgrades, or credits the user
```

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

### UserResource JSON:API resource

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/http-layer.md

Example JSON:API resource for User. Defines attributes and relationships to other resources. The toMeta method returns keys of loaded properties.

```php
class UserResource extends JsonApiResource
{
    public $attributes = ['id', 'first_name', 'last_name', 'email', 'email_verified_at', 'updated_at', 'created_at'];

    public $relationships = [
        'properties' => PropertyResource::class,
        'orders' => OrderResource::class,
        'services' => ServiceResource::class,
        'invoices' => InvoiceResource::class,
        'tickets' => TicketResource::class,
        'credits' => CreditResource::class,
        'role' => RoleResource::class,
    ];

    public function toMeta($request): array { /* keys of loaded properties */ }
}
```

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

### upgraded($oldVersion = null) - Called on update

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

Invoked by app:extension:upgrade (app/Console/Commands/Extension/Upgrade.php) after a re-upload detected an existing installation. The old version is read from the old ExtensionMeta attribute by UploadExtensionService.

```php
/**
 * Called when the extension is updated
 * This is called when the extension is updated to a new version
 *
 * @param  string  $oldVersion  The old version of the extension
 * @return void
 */
public function upgraded($oldVersion = null) {}
```

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

### getConfig($values = []) - Get configuration fields

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

Returns an array of Filament input definitions (objects with name, label, type, required, default, validation, encrypted, etc.). Each entry is later converted by App\Classes\FilamentInput::convert() (app/Classes/FilamentInput.php). Extensions override this to declare their settings UI.

```php
/**
 * Get the configuration fields for the extension
 *
 * @param  array  $values  The current values of the configuration (is empty on first load)
 * @return array
 */
public function getConfig($values = [])
{
    return [];
}
```

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

### boot()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

Called every request to the extension (if the extension is enabled). Override to register routes, views, events, or Livewire components.

```APIDOC
## boot()

### Description
Called every request to the extension (if the extension is enabled).

### Method
boot

### Signature
```php
public function boot() {}
```

### Return
- **void**

### Behavior
Called once per process boot for every enabled extension (and for all server/gateway extensions) in `AppServiceProvider::boot()` (`app/Providers/AppServiceProvider.php`). Built-in extensions use `boot()` to `require` their `routes.php`, register webhook routes, add view namespaces, listen to events and register Livewire components (see `extensions/Gateways/Stripe/Stripe.php`, `extensions/Others/Affiliates/Affiliates.php`).
```

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

### Usage example for Cidr and Domain rules

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/rules.md

Shows how to instantiate and use the Cidr and Domain rules in a Laravel validation rules array. The Cidr rule is configured with allowWildCard: true.

```php
use App\Rules\Cidr;
use App\Rules\Domain;

$rules = [
    'trusted_proxy' => ['required', new Cidr(allowWildCard: true)],
    'domain' => ['required', new Domain],
];
```

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

### Get telemetry data: Settings::getTelemetry()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

Returns compact('uuid', 'hour', 'minute') — a per-install telemetry_uuid setting (generated via Uuid::uuid4() when missing) and a deterministic daily send time derived from the UUID ((hexdec(last 14 hex chars) % 1440) → hour/minute).

```php
public static function getTelemetry()
```

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

### Catalog lookup with Product model

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/models-catalog.md

Shows how to load a product with its related plans, prices, and config options, then iterate over available plans and output the plan name and formatted total price when available.

```php
use App\Models\Product;

$product = Product::with('plans.prices', 'configOptions.children.plans.prices')->findOrFail($id);

foreach ($product->availablePlans($currencyCode) as $plan) {
    $price = $plan->price($currencyCode);
    if ($price->available) {
        echo $plan->name, $price->formatted->total;
    }
}

```

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

### DashboardPeriod enum

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/types.md

String-backed enum with cases Day, Week, Month, Year and methods default(), fromValue(), options(), label(), start(), interval(), dateFormat(). fromValue() resolves user input with a Month fallback. start() returns the start of the previous period. interval() returns the laravel-trend bucket size and dateFormat() the chart axis label format. Used by the admin dashboard widget aggregates.

```php
enum DashboardPeriod: string
{
    case Day = 'today';
    case Week = 'week';
    case Month = 'month';
    case Year = 'year';

    public static function default(): self
    {
        return self::Month;
    }

    public static function fromValue(?string $value): self
    {
        return self::tryFrom((string) $value) ?? self::default();
    }

    public static function options(): array
    public function label(): string            // 'Last 24 hours' | 'Last 7 days' | 'Last 30 days' | 'Last 365 days'
    public function start(?CarbonInterface $from = null): CarbonInterface
    public function interval(): string         // 'hour' (Day) | 'day' (Week, Month) | 'month' (Year)
    public function dateFormat(): string       // 'H:i' (Day) | 'M' (Year) | 'M d' (Week, Month)
}
```

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

### Using Navigation::getLinks()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/navigation.md

Shows how to retrieve the shop navigation links and iterate over them, checking the 'condition' and 'active' flags for rendering and highlighting.

```php
use App\Classes\Navigation;

$nav = Navigation::getLinks();                    // cached for the request
foreach ($nav as $item) {
    if ($item['condition'] ?? true) { /* render item */ }
    if ($item['active']) { /* highlight */ }
}
```

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

### GET /api/me

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Retrieves the authenticated user's profile.

```APIDOC
## GET /api/me

### Description
Returns the authenticated user's profile. Requires an OAuth2 access token with the `profile` scope.

### Method
GET

### Endpoint
/api/me

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token.

### Response
#### Success Response (200)
- **id** (integer) - User ID.
- **first_name** (string) - User's first name.
- **last_name** (string) - User's last name.
- **email** (string) - User's email address.
- **email_verified_at** (string|null) - Email verification timestamp.
- **created_at** (string) - Creation timestamp.
- **updated_at** (string) - Update timestamp.

#### Response Example
{
  "id": 1,
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "email_verified_at": "2024-01-01T00:00:00.000000Z",
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z"
}

```

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

### getView(Service $service, $view)

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension-helper.md

Gets a view for a service.

```APIDOC
## getView(Service $service, $view)

### Description
Gets a view for a service.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
- **$service** (Service) - Required - The service for which to get the view.
- **$view** (mixed) - Required - The view identifier; if `$view['function']` is set, that function is called, otherwise `getView` is called with `$view['name']` as the final argument.

### Request Example
N/A

### Response
#### Success Response
- **Return:** Result of the view function.

#### Response Example
N/A
```

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

### Server extension configuration methods

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/server-extension.md

Required configuration methods from the server stub. getConfig returns settings UI definitions, getProductConfig returns per-product config options, and testConfig returns true when valid or a string error message otherwise.

```php
public function getConfig($values = []): array
{
    return [];
}

/**
 * Get product config
 *
 * @param array $values
 * @return array
 */
public function getProductConfig($values = []): array
{
    return [];
}

/**
* Check if currenct configuration is valid
*
* @return bool|string
*/
public function testConfig(): bool|string
{
    return true;
}
```

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

### getActions(Service $service)

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension-helper.md

Gets available actions for a service.

```APIDOC
## getActions(Service $service)

### Description
Gets available actions for a service.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
- **$service** (Service) - Required - The service for which to get actions.

### Request Example
N/A

### Response
#### Success Response
- **Return:** Result of the server's `getActions` method.

#### Response Example
N/A
```

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

### SettingsProvider::getSettings($force = false)

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

Loads settings from the database into the config, applies overrides, sets timezone and theme, and forces HTTPS/root URL.

```APIDOC
## SettingsProvider::getSettings($force = false)

### Description
Loads `Setting` rows into `config('settings')` (cached under cache key `settings`), applies `override` entries (e.g. `app.name`, `mail.mailers.smtp.host`, `settings.*` → framework config), includes `app/Classes/helpers.php`, sets the timezone, applies the theme (`Theme::set`), registers theme lang namespace, and forces HTTPS / root URL from `app.url`. Skips when `config('settings')` already populated (unless `$force`). Returns early for `config:cache`/`optimize` commands.

### Method
`public static function getSettings($force = false): void`

### Parameters
- **$force** (bool) - Optional - Default: false - If true, forces reloading even if config is already populated.

### Return
- **Type:** `void`

### Example
```php
SettingsProvider::getSettings(true);
```
```

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

### SettingsProvider service provider methods

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

SettingsProvider methods that load settings at boot and keep them in sync. getSettings loads Setting rows into config('settings') (cached under cache key 'settings'), applies override entries, includes helpers.php, sets the timezone, applies the theme, registers theme lang namespace, and forces HTTPS / root URL. Skips when already populated (unless $force). flushCache forgets the settings cache, restarts the queue worker, and re-runs getSettings(true).

```php
public function register(): void
```

```php
public function boot(): void
```

```php
public static function getSettings($force = false): void
```

```php
public static function flushCache()
```

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

### GET /api/v1/admin/{resource}/{id}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Retrieves a single resource by ID.

```APIDOC
## GET /api/v1/admin/{resource}/{id}

### Description
Retrieves a single resource by ID. Requires the `admin.<resource>.view` permission.

### Method
GET

### Endpoint
/api/v1/admin/{resource}/{id}

### Parameters
#### Path Parameters
- **resource** (string) - Required - Resource name.
- **id** (integer) - Required - Resource ID.

#### Query Parameters
- **include** (string) - Optional - Comma-separated related resources.

### Response
#### Success Response (200)
- **data** (object) - The resource object.

#### Response Example
{
  "data": {}
}

```

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

### GET /account/notifications

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the account notifications page. Requires authentication.

```APIDOC
## GET /account/notifications

### Description
Displays the account notifications page. Requires authentication.

### Method
GET

### Endpoint
/account/notifications

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Client\Notifications Livewire component.
```

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

### createServer(Service $service)

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension-helper.md

Creates a server for a service.

```APIDOC
## createServer(Service $service)

### Description
Creates a server for the given service.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
- **$service** (Service) - Required - The service for which to create the server.

### Request Example
N/A

### Response
#### Success Response
- **Return:** Result of the server's `createServer` method.

#### Response Example
N/A
```

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

### GET /account/credits

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the account credits page. Requires authentication.

```APIDOC
## GET /account/credits

### Description
Displays the account credits page. Requires authentication.

### Method
GET

### Endpoint
/account/credits

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Client\Credits Livewire component.
```

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

### GET /2fa

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the two-factor authentication page. Accessible only to guests.

```APIDOC
## GET /2fa

### Description
Displays the two-factor authentication page. Accessible only to guests.

### Method
GET

### Endpoint
/2fa

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Auth\Tfa Livewire component.
```

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

### GET /email/verify

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the email verification notice page. Requires authentication.

```APIDOC
## GET /email/verify

### Description
Displays the email verification notice page. Requires authentication.

### Method
GET

### Endpoint
/email/verify

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Auth\VerifyEmail Livewire component.
```

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

### Reading merged settings with config()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/configuration.md

Shows how to read a merged admin setting with a default value and how the app.url config is overridden by the app_url setting at boot.

```php
config('settings.cronjob_invoice', 7);   // admin setting with default
config('app.url');                       // overridden by the app_url setting at boot
```

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

### GET /account/payment-methods

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the account payment methods page. Requires authentication.

```APIDOC
## GET /account/payment-methods

### Description
Displays the account payment methods page. Requires authentication.

### Method
GET

### Endpoint
/account/payment-methods

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Client\PaymentMethods Livewire component.
```

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

### createBillingAgreement(User $user) default implementation

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/gateway.md

Throws an exception by default. Override to return a view or a redirect URL for setting up the agreement. Called by ExtensionHelper::createBillingAgreement().

```php
/**
 * Create a billing agreement for the given user.
 *
 * @param  string  $currencyCode
 * @return View|string
 */
public function createBillingAgreement(User $user)
{
    throw new \Exception('Not implemented');
}
```

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

### GET /account/security

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the account security settings page. Requires authentication.

```APIDOC
## GET /account/security

### Description
Displays the account security settings page. Requires authentication.

### Method
GET

### Endpoint
/account/security

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Client\Security Livewire component.
```

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

### GET /account

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the user account settings page. Requires authentication.

```APIDOC
## GET /account

### Description
Displays the user account settings page. Requires authentication.

### Method
GET

### Endpoint
/account

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Client\Account Livewire component.
```

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

### Add item to cart with Cart::add

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/cart.md

Shows how to add a product to the cart using the Cart::add method. Requires a Product and Plan model instance, and accepts optional config options and checkout configuration arrays.

```php
use App\Classes\Cart;
use App\Models\Product;
use App\Models\Plan;

$product = Product::findOrFail($id);
$plan = $product->plans->first();

$itemId = Cart::add(
    $product,
    $plan,
    [['option_id' => 3, 'value' => 12]], // config options
    ['notes' => '']                      // checkout config
);
```

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

### GET /dashboard

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the user dashboard. Requires authentication and email verification.

```APIDOC
## GET /dashboard

### Description
Displays the user dashboard. Requires authentication and email verification.

### Method
GET

### Endpoint
/dashboard

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Dashboard Livewire component.
```

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

### Register listeners via Laravel event discovery

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/events.md

Shows how to configure event discovery in bootstrap/app.php to automatically register listeners from the specified directories.

```php
->withEvents(discover: [__DIR__ . '/../app/Extensions', __DIR__ . '/../app/Listeners'])
```

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

### GET /password/request

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the password reset request form. Accessible only to guests.

```APIDOC
## GET /password/request

### Description
Displays the password reset request form. Accessible only to guests.

### Method
GET

### Endpoint
/password/request

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Auth\Password\Request Livewire component.
```

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

### Settings::settings()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/settings.md

Returns the complete settings catalog grouped by category. Each entry is a descriptor array with name, label, type, default, required, validation, and override.

```APIDOC
## Settings::settings()

### Description
Returns the complete admin-editable settings catalog grouped by category. Each entry is a descriptor array with fields such as name, label, type, default, required, validation, and override.

### Method
`public static function settings()`

### Return
- **Type:** `array`
- **Description:** Grouped by category: `general`, `security`, `social-login`, `tax`, `mail`, `tickets`, `cronjob`, `credits`, `theme`, `invoices`, `other`. Theme settings from `Theme::getSettings()` are merged under `theme`.

### Example
```php
$settings = Settings::settings();
```
```

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

### GET /login

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the login page for user authentication. Accessible only to guests.

```APIDOC
## GET /login

### Description
Displays the login page for user authentication. Accessible only to guests.

### Method
GET

### Endpoint
/login

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Auth\Login Livewire component.
```

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

### callService(Service $service, $function, $args = [], $mayFail = false)

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension-helper.md

Calls a method on the product's server with service context.

```APIDOC
## callService(Service $service, $function, $args = [], $mayFail = false)

### Description
Resolves the product's server and calls the given function on the server instance with service, settings, and properties. Throws if no server is assigned and `$mayFail` is truthy.

### Method
`callService` (static)

### Parameters
- **$service** (Service) - Required - The service instance.
- **$function** (string) - Required - The method name to call on the server.
- **$args** (array) - Optional - Additional arguments to pass. Default `[]`.
- **$mayFail** (bool) - Optional - If `true`, missing server throws an exception; otherwise returns. Default `false`.

### Throws
- **Exception** - `'No server assigned to this product'` when no server is assigned and `$mayFail` is truthy.

### Return
- **mixed** - The result of the server method call.
```

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

### GET /cart

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the shopping cart page. Accessible to users with the checkout middleware.

```APIDOC
## GET /cart

### Description
Displays the shopping cart page. Accessible to users with the checkout middleware.

### Method
GET

### Endpoint
/cart

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Cart Livewire component.
```

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

### GET /password/reset/{token}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the password reset form with a token. Accessible only to guests.

```APIDOC
## GET /password/reset/{token}

### Description
Displays the password reset form with a token. Accessible only to guests.

### Method
GET

### Endpoint
/password/reset/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - The password reset token.

### Response
#### Success Response (200)
- HTML page rendered by the Auth\Password\Reset Livewire component.
```

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

### boot() - Called every request and its invocation loop

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

The boot() method is called once per process boot for every enabled extension (and for all server/gateway extensions) in AppServiceProvider::boot() (app/Providers/AppServiceProvider.php). The second block shows the invocation loop. Built-in extensions use boot() to require their routes.php, register webhook routes, add view namespaces, listen to events, and register Livewire components.

```php
/**
 * Called every request to the extension (if the extension is enabled)
 *
 * @return void
 */
public function boot() {}
```

```php
foreach (collect(Extension::where(function ($query) {
    $query->where('enabled', true)->orWhere('type', 'server')->orWhere('type', 'gateway');
})->get())->unique('extension') as $extension) {
    ExtensionHelper::call($extension, 'boot', mayFail: true);
}
```

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

### Server lifecycle methods

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/server-extension.md

Required lifecycle methods for server extensions. All share the same parameters: service (App\Models\Service), settings (product settings from getProductConfig), and properties (merged custom property and config-option values). createServer's return value is stored by Jobs/Server/CreateJob.php and used as notification data when it is an array.

```php
/**
 * Create a server for the service.
 *
 * @param Service $service The service that is being created.
 * @param array $settings The settings that are provided on the product from `getProductConfig`.
 * @param array $properties Custom properties created by the admin and values coming from `getCheckoutConfig`.
 */
public function createServer(Service $service, $settings, $properties)
{
    return false;
}

/**
 * Suspend a server
 *
 * @param Service $service
 * @param array $settings (product settings)
 * @param array $properties (checkout options)
 * @return bool
 */
public function suspendServer(Service $service, $settings, $properties)
{
    return false;
}

/**
 * Unsuspend a server
 *
 * @param Service $service
 * @param array $settings (product settings)
 * @param array $properties (checkout options)
 * @return bool
 */
public function unsuspendServer(Service $service, $settings, $properties)
{
    return false;
}

/**
 * Terminate a server
 *
 * @param Service $service
 * @param array $settings (product settings)
 * @param array $properties (checkout options)
 * @return bool
 */
public function terminateServer(Service $service, $settings, $properties)
{
    return false;
}
```

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

### createCart()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/cart.md

Static method to get or create the cart row and set the associated cookie.

```APIDOC
## createCart()

### Description
Gets or creates the cart row, setting `user_id` from the authenticated user and `currency_code` from the session or default settings. Queues a 30-day cookie and returns a fresh model instance.

### Method
`public static function createCart()`

### Return
- **Type:** `App\Models\Cart`
- **Description:** The created or existing cart instance.

### Example
```php
$cart = Cart::createCart();
```
```

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

### GET /invoices

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the list of invoices for the authenticated user. Requires authentication and email verification.

```APIDOC
## GET /invoices

### Description
Displays the list of invoices for the authenticated user. Requires authentication and email verification.

### Method
GET

### Endpoint
/invoices

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Invoices\Index Livewire component.
```

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

### Extension with settings and lifecycle hooks

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/extension.md

An extension that uses settings and lifecycle hooks. getConfig defines a text field named 'message' that is required. boot() is for registering routes, views, or listeners, and upgraded() is called when the extension version changes, useful for migrating settings.

```php
namespace Paymenter\Extensions\Others\Announcer;

use App\Classes\Extension\Extension;

class Announcer extends Extension
{
    public function getConfig($values = [])
    {
        return [
            ['name' => 'message', 'label' => 'Message', 'type' => 'text', 'required' => true],
        ];
    }

    public function boot()
    {
        // register routes, views, listeners...
    }

    public function upgraded($oldVersion = null)
    {
        // migrate settings when the version changes
    }
}

```

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

### Service showing server actions in app/Livewire/Services/Show.php

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/server-extension.md

Retrieves server actions via ExtensionHelper::getActions() and separates them into buttons, views, and text fields. The try-catch swallows any exception, so the page continues without actions if the service has no server extension.

```php
$actions = [];
try {
    $actions = ExtensionHelper::getActions($this->service);
} catch (Exception $e) {
}
// separate the actions into buttons and views
foreach ($actions as $action) {
    if ($action['type'] == 'button') {
        $this->buttons[] = $action;
    } elseif ($action['type'] == 'view') {
        $this->views[] = $action;
    } elseif ($action['type'] == 'text') {
        $this->fields[] = $action;
    }
}
```

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

### GET /tickets/attachments/{attachment:uuid}

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Downloads a ticket attachment. Requires authentication and the 'view' ability on the attachment.

```APIDOC
## GET /tickets/attachments/{attachment:uuid}

### Description
Downloads a ticket attachment. Requires authentication and the 'view' ability on the attachment.

### Method
GET

### Endpoint
/tickets/attachments/{attachment:uuid}

### Parameters
#### Path Parameters
- **attachment:uuid** (string) - Required - The UUID of the attachment.

### Response
#### Success Response (200)
- File download.
```

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

### getOnce()

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/api-reference/cart.md

Static method to retrieve the current cart or create a new unsaved instance.

```APIDOC
## getOnce()

### Description
Returns the cart belonging to the current `cart` cookie, eagerly loaded with related items, plans, products, and config options. If no cart cookie or row exists, returns a new unsaved `App\Models\Cart` instance.

### Method
`public static function getOnce()`

### Return
- **Type:** `App\Models\Cart`
- **Description:** The cart for the current session, or a new unsaved instance.

### Example
```php
$cart = Cart::getOnce();
```
```

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

### GET /tickets

Source: https://github.com/paymenter/paymenter/blob/master/_autodocs/endpoints.md

Displays the list of support tickets for the authenticated user. Requires authentication and email verification.

```APIDOC
## GET /tickets

### Description
Displays the list of support tickets for the authenticated user. Requires authentication and email verification.

### Method
GET

### Endpoint
/tickets

### Parameters
None

### Response
#### Success Response (200)
- HTML page rendered by the Tickets\Index Livewire component.
```
Tokens:
Raw