### Create Payment Example (PHP)

Source: https://developers.paylix.gg/index

Example of creating a payment using the Paylix PHP SDK. This snippet demonstrates how to initialize the SDK with API keys and merchant name, and then construct a payment payload with essential details like title, value, currency, quantity, and email. It also includes settings for white-labeling and return URLs, with error handling for potential exceptions.

```PHP
<?php
  use PaylixPhpSdkPaylix;
  use PaylixPhpSdkPaylixException;

  $paylix = new Paylix("<YOUR_API_KEY>", "<MERCHANT_NAME>");
  $payment_payload = [
    "title" => "Paylix Payment",
    "value" => 1.5,
    "currency" => "EUR",
    "quantity" => 5,
    "email" => "no-reply@paylix.gg",
    "white_label" => false,
    "return_url" => "https://sample.paylix.gg/return"
  ];

  try {

```

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

### Paginating Orders Example

Source: https://developers.paylix.gg/index

An example of how to paginate list endpoints in the Paylix API. Specify the 'page' parameter with the desired page number to retrieve specific sets of resources.

```url
/blacklists?page=1
```

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

### Group Object JSON Example

Source: https://developers.paylix.gg/index

This JSON object represents a sample Group from the Paylix API. It includes details about the group itself and a list of associated products, each with its own set of attributes like pricing, recurring intervals, and gateway compatibility. This example demonstrates the structure for managing product groupings and their configurations.

```json
{
  "id": 0,
  "uniqid": "sample29a0e39d",
  "shop_id": 0,
  "title": "Software Group",
  "unlisted": false,
  "sort_priority": 1,
  "products_bound": [
    {
      "id": 0,
      "uniqid": "sample29a0e39d",
      "shop_id": 0,
      "type": "SUBSCRIPTION",
      "subtype": null,
      "title": "Digital good to download",
      "currency": "EUR",
      "price": 5,
      "price_display": 4.5,
      "description": "Product description",
      "image_attachment": null,
      "file_attachment": null,
      "volume_discounts": [
        {
          "type": "PERCENTAGE",
          "value": 5,
          "quantity": 10
        }
      ],
      "recurring_interval": "MONTH",
      "recurring_interval_count": 1,
      "trial_period": 0,
      "paypal_product_id": null,
      "paypal_plan_id": null,
      "stripe_price_id": "price_sample2X7rAeMb7AM5APEU",
      "quantity_min": 1,
      "quantity_max": -1,
      "quantity_warning": 0,
      "gateways": [
        "PAYPAL",
        "STRIPE",
        "BITCOIN"
      ],
      "custom_fields": [
        {
          "type": "checkbox",
          "name": "Read the ToS",
          "regex": null,
          "placeholder": null,
          "default": null,
          "required": false
        }
      ],
      "crypto_confirmations_needed": 3,
      "max_risk_level": 85,
      "block_vpn_proxies": true,
      "delivery_text": "Thank you for purchasing this subscription!",
      "service_text": "In order to get you services, please contact us at..",
      "stock_delimiter": ",",
      "stock": -1,
      "dynamic_webhook": null,
      "sort_priority": 1,
      "unlisted": false,
      "on_hold": false,
      "terms_of_service": null,
      "warranty": 86400,
      "warranty_text": "This warranty covers..",
      "private": false,
      "name": "paylixecommerce",
      "image_name": null,
      "image_storage": null,
      "cloudflare_image_id": "sample-c4f1-4f7c-9a1d-89120ed0c800",
      "serials": [],
      "webhooks": [],
      "feedback": {
        "total": 10,
        "positive": 8,
        "neutral": 1,
        "negative": 0
      },
      "theme": "light",
      "dark_mode": 0,
      "average_score": 4.5,
      "sold_count": 5,
      "lex_payment_methods": [],
      "created_at": 162857125819,
      "updated_at": 162857125819,
      "updated_by": 0
    }
  ],
  "products_count": 1,
  "created_at": 162857125819,
  "updated_at": 162857125819,
  "updated_by": 0
}
```

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

### Products API

Source: https://developers.paylix.gg/index

Manage products. You can get, list, create, edit, and delete products.

```APIDOC
## Products

### Product Object
Represents a product.

### Get a Product
Retrieves a specific product.

### List All Products
Retrieves a list of all products.

### Create a Product
Creates a new product.

### Edit Product
Edits an existing product.

### Delete Product
Deletes a product.
```

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

### Queries API

Source: https://developers.paylix.gg/index

Manage queries. You can get, list, reply, close, and reopen queries.

```APIDOC
## Queries

### Query Object
Represents a query.

### Get a Query
Retrieves a specific query.

### List All Queries
Retrieves a list of all queries.

### Reply Query
Replies to a query.

### Close Query
Closes a query.

### Reopen Query
Reopens a query.
```

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

### Setup Authentication Header

Source: https://developers.paylix.gg/index

Demonstrates how to set up the Authorization header using a Bearer token for API authentication. Replace 'testingjHdAZK6jG2pN6cabSQdZhlS2XqE8UvOSdqSDtlZAeOuF2jfr3a87KKs3Z' with your actual API Secret Key.

```http
Authorization: Bearer testingjHdAZK6jG2pN6cabSQdZhlS2XqE8UvOSdqSDtlZAeOuF2jfr3a87KKs3Z
```

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

### Check License

Source: https://developers.paylix.gg/index

Issues a license check request. This can be used, for example, every time your application is started from a customer device to verify both the license key and hardware ID.

```APIDOC
## POST /products/licensing/check

### Description
Check license. Issue a check license request, for example, every time your application is started from a customer device. You can then check for both the license key and hardware id, being sure that the customer has paid for it.

### Method
POST

### Endpoint
/products/licensing/check

### Parameters
#### Query Parameters
- **keystring** (string) - Required - License key purchased by the customer.
- **product_id** (string) - Required - UNIQID of the product.
- **hardware_id** (string) - Optional - If specified, the hardware_id must match along with the key.

### Request Example
```php
<?php
  use PaylixPhpSdkPaylix;
  use PaylixPhpSdkPaylixException;

  $paylix = new Paylix("<YOUR_API_KEY>", "<MERCHANT_NAME>");
  $check_payload = [
    "key" => "demo-key",
    "product_id" => "64ewq132e2323",
    "hardware_id" => "hardware-example"
  ];

  try {
    $check = $paylix->licensing_check($check_payload);
  } catch (PaylixException $e) {
    echo $e->__toString();
  }
?>
```

### Response
#### Success Response (200)
- **is_valid** (boolean) - Indicates if the license is valid.
- **message** (string) - A message detailing the license status.

#### Response Example
```json
{
  "is_valid": true,
  "message": "License is valid."
}
```
```

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

### Payment Initialization with Crypto Details

Source: https://developers.paylix.gg/index

This snippet illustrates the initial setup for a payment, specifically highlighting cryptocurrency details. It includes the crypto address, amount, the generated URI for payment initiation, and configuration for confirmations and payout.

```json
{
  "paydash_paymentID": null,
  "stripe_client_secret": null,
  "stripe_price_id": null,
  "skrill_email": null,
  "skrill_sid": null,
  "skrill_link": null,
  "perfectmoney_id": null,
  "crypto_address": "3RUx8gs74R5KdXrs8wU6Z2xQkS8jmGVCnTVTRpwSoE3B",
  "crypto_amount": 0.014174,
  "crypto_received": 0.014174,
  "crypto_uri": "solana:3RUx8gs74R5KdXrs8wU6Z2xQkS8jmGVCnTVTRpwSoE3B?amount=0.014174",
  "crypto_confirmations_needed": 1,
  "crypto_scheduled_payout": false,
  "crypto_payout": true,
  "fee_billed": true,
  "bill_info": null,
  "cashapp_qrcode": null,
  "cashapp_cashtag": null,
  "cashapp_note": null,
  "country": "IT",
  "location": "Bologna, Emilia-Romagna (Europe/Rome)",
  "ip": "255.11.12.255",
  "is_vpn_or_proxy": false,
  "user_agent": "PostmanRuntime/7.26.8",
  "quantity": 5,
  "coupon_id": null,
  "custom_fields": {
    "username": "paylixecommerce-user"
  },
  "developer_invoice": false,
  "developer_title": null,
  "developer_webhook": null,
  "developer_return_url": null,
  "status": "COMPLETED",
  "status_details": null,
  "void_details": null,
  "discount": 0,
  "fee_percentage": 5
}
```

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

### Introduction

Source: https://developers.paylix.gg/index

Welcome to the Paylix REST API. You can use our API to access Paylix API endpoints to build your own systems on top of our platform.

```APIDOC
## Introduction

Welcome to the Paylix REST API. You can use our API to access Paylix API endpoints to build your own systems on top of our platform.

### API Root URL
```
https://dev.paylix.gg/v1
```
```

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

### Create Product with Paylix API (PHP, NodeJS, Python)

Source: https://developers.paylix.gg/index

This snippet demonstrates how to create a product using the Paylix API. It requires an API key and merchant name for authentication. The function accepts a payload containing product details such as title, price, description, currency, gateways, type, and other optional configurations. It returns the unique identifier (uniqid) of the created product or throws an exception if an error occurs. Dependencies include the Paylix SDK for each respective language.

```php
<?php
  use \Paylix\PhpSdk\Paylix;
  use \Paylix\PhpSdk\PaylixException;

  $paylix = new Paylix("<YOUR_API_KEY>", "<MERCHANT_NAME>");
  $product_payload = [
    "title" => "Software Activation Keys",
    "price" => 12.5,
    "description" => "Product description example.",
    "currency" => "EUR",
    "gateways" => ["PAYPAL","STRIPE","BITCOIN"],
    "type" => "SERIALS",
    "serials" => [
      "activation-key-#1"
    ]
  ];

  try {
    $product_uniqid = $paylix->create_product($product_payload);
  } catch (PaylixException $e) {
    echo $e->__toString();
  }
?>
```

```javascript
// NodeJS Example (assuming a Paylix SDK is available)
// const Paylix = require('paylix-sdk');
// const paylix = new Paylix('<YOUR_API_KEY>', '<MERCHANT_NAME>');

// const product_payload = {
//   title: 'Software Activation Keys',
//   price: 12.5,
//   description: 'Product description example.',
//   currency: 'EUR',
//   gateways: ['PAYPAL', 'STRIPE', 'BITCOIN'],
//   type: 'SERIALS',
//   serials: [
//     'activation-key-#1'
//   ]
// };

// paylix.createProduct(product_payload)
//   .then(product_uniqid => {
//     console.log('Product created:', product_uniqid);
//   })
//   .catch(error => {
//     console.error('Error creating product:', error);
//   });
```

```python
# Python Example (assuming a Paylix SDK is available)
# from paylix_sdk import Paylix, PaylixException

# paylix = Paylix('<YOUR_API_KEY>', '<MERCHANT_NAME>')

# product_payload = {
#   'title': 'Software Activation Keys',
#   'price': 12.5,
#   'description': 'Product description example.',
#   'currency': 'EUR',
#   'gateways': ['PAYPAL', 'STRIPE', 'BITCOIN'],
#   'type': 'SERIALS',
#   'serials': [
#     'activation-key-#1'
#   ]
# }

# try:
#   product_uniqid = paylix.create_product(product_payload)
#   print(f'Product created: {product_uniqid}')
# except PaylixException as e:
#   print(f'Error creating product: {e}')
```

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

### Get a Subscription

Source: https://developers.paylix.gg/index

Retrieves a specific subscription using its unique identifier.

```APIDOC
## GET /subscriptions/:uniqid

### Description
Retrieves a Subscription by Uniqid.

### Method
GET

### Endpoint
/subscriptions/:uniqid

#### Path Parameters
- **uniqid** (string) - Required - The unique identifier of the subscription.

### Request Example
```php
<?php
  use \Paylix\PhpSdk\Paylix;
  use \Paylix\PhpSdk\PaylixException;

  $paylix = new Paylix("<YOUR_API_KEY>", "<MERCHANT_NAME>");
  $subscription_uniqid = "<SUBSCRIPTION_UNIQID>";

  try {
    $subscription = $paylix->get_subscription($subscription_uniqid);
  } catch (PaylixException $e) {
    echo $e->__toString();
  }
?>
```

### Response
#### Success Response (200)
- **status** (integer) - The status code of the response.
- **data** (object) - Contains the subscription details.
  - **subscription** (object) - Details of the retrieved subscription.
    - **id** (string) - The unique ID of the subscription.
    - **shop_id** (integer) - The ID of the shop.
    - **product_id** (string) - The ID of the product.
    - **status** (string) - The current status of the subscription.
    - **gateway** (string) - The payment gateway used.
    - **custom_fields** (object) - Custom fields associated with the subscription.
    - **customer_id** (string) - The ID of the customer.
    - **stripe_customer_id** (string) - The Stripe customer ID.
    - **stripe_account** (string) - The Stripe account ID.
    - **stripe_subscription_id** (string) - The Stripe subscription ID.
    - **coupon_id** (string|null) - The ID of the coupon applied, or null.
    - **current_period_end** (integer) - The end date of the current billing period.
    - **upcoming_email_1_week_sent** (boolean) - Indicates if the 1-week upcoming email was sent.
    - **trial_period_ending_email_sent** (boolean) - Indicates if the trial ending email was sent.
    - **renewal_invoice_created** (boolean) - Indicates if a renewal invoice was created.
    - **created_at** (integer) - Timestamp of when the subscription was created.
    - **updated_at** (integer) - Timestamp of when the subscription was last updated.
    - **canceled_at** (integer|null) - Timestamp of when the subscription was canceled, or null.
    - **product_title** (string) - The title of the product.
    - **customer_name** (string) - The name of the customer.
    - **customer_surname** (string) - The surname of the customer.
    - **customer_phone** (string|null) - The phone number of the customer, or null.
    - **customer_phone_country_code** (string|null) - The country code for the customer's phone number, or null.
    - **customer_country_code** (string|null) - The country code of the customer, or null.
    - **customer_street_address** (string|null) - The street address of the customer, or null.
    - **customer_additional_address_info** (string|null) - Additional address information for the customer, or null.
    - **customer_city** (string|null) - The city of the customer, or null.
    - **customer_postal_code** (string|null) - The postal code of the customer, or null.
    - **customer_state** (string|null) - The state of the customer, or null.
    - **customer_email** (string) - The email address of the customer.
- **message** (string|null) - Any message associated with the response, or null.
- **log** (string|null) - Log information, or null.
- **error** (string|null) - Any error message, or null.
- **env** (string) - The environment the API is running in.

#### Response Example
```json
{
  "status": 200,
  "data": {
    "subscription": {
      "id": "rec_sample-3afde4b6e1-82833e",
      "shop_id": 124,
      "product_id": "samplede6277597",
      "status": "CANCELED",
      "gateway": "STRIPE",
      "custom_fields": {
        "username": "paylixecommerce-user"
      },
      "customer_id": "cst_sample6addc898a645",
      "stripe_customer_id": "cus_samplegIE0YKwapE6",
      "stripe_account": "acct_sampleuMKb2X7rAeMb",
      "stripe_subscription_id": "sub_samplexpKb2X7rAeMbKdJc78AP",
      "coupon_id": null,
      "current_period_end": 1641313649,
      "upcoming_email_1_week_sent": false,
      "trial_period_ending_email_sent": false,
      "renewal_invoice_created": false,
      "created_at": 1641314317,
      "updated_at": 1641315120,
      "canceled_at": null,
      "product_title": "The title of the product for this subscription.",
      "customer_name": "James",
      "customer_surname": "Smith",
      "customer_phone": null,
      "customer_phone_country_code": null,
      "customer_country_code": null,
      "customer_street_address": null,
      "customer_additional_address_info": null,
      "customer_city": null,
      "customer_postal_code": null,
      "customer_state": null,
      "customer_email": "sample@gmail.com"
    }
  },
  "message": null,
  "log": null,
  "error": null,
  "env": "production"
}
```
```

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

### List Products using Paylix SDK (PHP)

Source: https://developers.paylix.gg/index

This snippet demonstrates how to retrieve a list of all products using the Paylix PHP SDK. It requires an API key and merchant name for initialization. The function `get_products()` is called within a try-catch block to handle potential exceptions.

```php
<?php
  use PaylixPhpSdkPaylix;
  use PaylixPhpSdkPaylixException;

  $paylix = new Paylix("<YOUR_API_KEY>", "<MERCHANT_NAME>");

  try {
    $products = $paylix->get_products();
  } catch (PaylixException $e) {
    echo $e->__toString();
  }
?>
```

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

### GET /categories/:uniqid

Source: https://developers.paylix.gg/index

Retrieves a specific category by its unique identifier.

```APIDOC
## GET /categories/:uniqid

### Description
Retrieves a Category by Uniqid.

### Method
GET

### Endpoint
/categories/:uniqid

### Parameters
#### Path Parameters
- **uniqid** (string) - Required - The unique identifier of the category to retrieve.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **status** (integer) - The status code of the response.
- **data** (object) - Contains the category data.
  - **category** (object) - Details of the retrieved category.
    - **id** (integer) - The internal ID of the category.
    - **uniqid** (string) - The unique identifier of the category.
    - **shop_id** (integer) - The ID of the shop the category belongs to.
    - **title** (string) - The title of the category.
    - **unlisted** (boolean) - Indicates if the category is unlisted.
    - **sort_priority** (integer) - The sorting priority of the category.
    - **products_bound** (array) - A list of products bound to this category.
    - **products_count** (integer) - The number of products in the category.
    - **groups_bound** (array) - A list of product groups bound to this category.
    - **groups_count** (integer) - The number of product groups in the category.
    - **created_at** (integer) - Timestamp of creation.
    - **updated_at** (integer) - Timestamp of last update.
    - **updated_by** (integer) - The ID of the user who last updated the category.
- **message** (null) - Any message associated with the response.
- **log** (null) - Log information.
- **error** (null) - Error details if any.
- **env** (string) - The environment the response was generated in.

#### Response Example
```json
{
  "status": 200,
  "data": {
    "category": {
      "id": 0,
      "uniqid": "sample29a0e39d",
      "shop_id": 0,
      "title": "Software",
      "unlisted": false,
      "sort_priority": 1,
      "products_bound": [
        {
          "id": 0,
          "uniqid": "sample29a0e39d",
          "shop_id": 0,
          "type": "SUBSCRIPTION",
          "subtype": null,
          "title": "Digital good to download",
          "currency": "EUR",
          "price": 5,
          "price_display": 4.5,
          "description": "Product description",
          "image_attachment": null,
          "file_attachment": null,
          "volume_discounts": [
            {
              "type": "PERCENTAGE",
              "value": 5,
              "quantity": 10
            }
          ],
          "recurring_interval": "MONTH",
          "recurring_interval_count": 1,
          "trial_period": 0,
          "paypal_product_id": null,
          "paypal_plan_id": null,
          "stripe_price_id": "price_sample2X7rAeMb7AM5APEU",
          "quantity_min": 1,
          "quantity_max": -1,
          "quantity_warning": 0,
          "gateways": [
            "PAYPAL",
            "STRIPE",
            "BITCOIN"
          ],
          "custom_fields": [
            {
              "type": "checkbox",
              "name": "Read the ToS",
              "regex": null,
              "placeholder": null,
              "default": null,
              "required": false
            }
          ],
          "crypto_confirmations_needed": 3,
          "max_risk_level": 85,
          "block_vpn_proxies": true,
          "delivery_text": "Thank you for purchasing this subscription!",
          "service_text": "In order to get you services, please contact us at..",
          "stock_delimiter": ",",
          "stock": -1,
          "dynamic_webhook": null,
          "sort_priority": 1,
          "unlisted": false,
          "on_hold": false,
          "terms_of_service": null,
          "warranty": 86400,
          "warranty_text": "This warranty covers..",
          "private": false,
          "name": "paylixecommerce",
          "image_name": null,
          "image_storage": null,
          "cloudflare_image_id": "sample-c4f1-4f7c-9a1d-89120ed0c800",
          "serials": [],
          "webhooks": [],
          "feedback": {
            "total": 10,
            "positive": 8,
            "neutral": 1,
            "negative": 0
          },
          "theme": "light",
          "dark_mode": 0,
          "average_score": 4.5,
          "sold_count": 5,
          "lex_payment_methods": [],
          "created_at": 162857125819,
          "updated_at": 162857125819,
          "updated_by": 0
        }
      ],
      "products_count": 1,
      "groups_bound": [
        {
          "uniqid": "sample29a0e39d",
          "title": "Digital goods to download",
          "image_attachment": null,
          "created_at": 162857125819,
          "updated_at": 162857125819
        }
      ],
      "groups_count": 1,
      "created_at": 162857125819,
      "updated_at": 162857125819,
      "updated_by": 0
    }
  },
  "message": null,
  "log": null,
  "error": null,
  "env": "production"
}
```
```

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

### POST /products

Source: https://developers.paylix.gg/index

Creates a new product in the Paylix system. This endpoint allows you to define product details such as title, price, description, currency, and more.

```APIDOC
## POST /products

### Description
Creates a Product and returns the Uniqid.

### Method
POST

### Endpoint
/products

### Parameters
#### Query Parameters
None

#### Request Body
- **title** (string) - REQUIRED - Product title.
- **price** (number) - REQUIRED - Product price.
- **description** (string) - REQUIRED - Product description.
- **currency** (string) - Optional - Enum: "CAD", "HKD", "ISK", "PHP", "DKK", "HUF", "CZK", "G…", "ZAR", "USD", "MXN", "SGD", "AUD", "ILS", "KRW", "PLN". Available currency.
- **gateways** (array of strings) - Optional - Items Enum: "PAYPAL", "STRIPE", "SKRILL", "PERFECT_MONEY", "SUMUP", "PADDLE", "CASH_APP", "SOLANA", "BITCOIN", "ETHEREUM", "LITECOIN", "TRON", "BITCOIN_CASH", "BINANCE_COIN", "MONERO", "DOGE", "SHIB", "DAI", "POLYGON", "USDT:MATIC", "USDC:ERC20", "USDC:BEP20", "USDT:ERC20", "USDT:TRC20", "USDT:BEP20"
- **type** (string) - REQUIRED - Enum: "SERIALS", "FILE", "SERVICE", "DYNAMIC", "INFO_CARD", "SUBSCRIPTION". Product type.
- **serials** (array of strings) - Optional - Array of the serials in stock for this product.
- **serials_remove_duplicates** (boolean) - Optional - Used for product type SERIALS. If true, we will check your previous serials sold as well as the stock you're trying to submit in order to remove any possible duplicate and avoid issues with your customers.
- **service_text** (string) - Optional - Text sent to the customer if product type is SERVICE.
- **stock** (integer) - Optional - Stock of the current product, can be -1 for unlimited stock.
- **dynamic_webhook** (string) - Optional - Product webhook for product type DYNAMIC. We will send here a request for a COMPLETED invoice in order to get the product for the customer.
- **stock_delimiter** (string) - Optional - How to delimit the stock if product type is SERIALS, for example with stock_delimiter "," and serials value first,second; the stock would have two different serials "first" and "second".
- **min_quantity** (integer) - Optional - Product minimum quantity
- **max_quantity** (integer) - Optional - Product maximum quantity
- **delivery_text** (string) - Optional - Text sent to the customer after the purchase.
- **custom_fields** (object) - Optional - key-value JSON having as key the custom field name and as value the custom field value inserted by the customer. Custom fields can both be used as inputs from the customers but also as metadata for invoices, letting you pass hidden fields for internal referencing.
- **crypto_confirmations_needed** (integer) - Optional - Minimum number of confirmations for a crypto payments to be accepted.
- **max_risk_level** (integer) - Optional - For PAYPAL and STRIPE, maximum risk level to accept payments in order to block fraud attempts.
- **unlisted** (boolean) - Optional - If unlisted is true, the product is not shown in the storefront but can be bought through a direct link.
- **private** (boolean) - Optional - If private is true, the product is hidden on the storefront and cannot be bought with a direct link.
- **block_vpn_proxies** (boolean) - Optional - Block VPN and Proxy purchases if the gateway is PAYPAL or STRIPE.
- **sort_priority** (integer) - Optional - Sort order of this product.
- **webhooks** (array of strings) - Optional - Array of the webhook URLs for this product.
- **on_hold** (boolean) - Optional - If on_hold is true, the product cannot be bought but is shown in the storefront.
- **terms_of_service** (string) - Optional - Text containing the product's terms of service.
- **warranty** (integer) - Optional - Time, in seconds, of how much the warranty for this product lasts.
- **warranty_text** (string) - Optional - Clear explanation of what the warranty covers.
- **remove_images** (boolean) - Optional - True to remove every product images.
- **remove_files** (boolean) - Optional - True to remove every product files.
- **volume_discounts** (object) - Optional - Array of volume discounts.
- **price_variants** (object) - Optional - Array of price variants. If type is SERIALS, stock for the variant should be provided in this object.
- **recurring_interval** (string) - Optional - Enum: "DAY", "WEEK", "MONTH", "YEAR". At which frequency the customer is billed for product type SUBSCRIPTION.
- **recurring_interval_count** (integer) - Optional - How many recurring_interval before the customer is billed for product type SUBSCRIPTION.
- **trial_period** (integer) - Optional - Defines a trial period before billing the customer for product type SUBSCRIPTION.
- **youtube_link** (string) - Optional - URL of a youtube video that will be displayed in the product page.
- **watermark_enabled** (boolean) - Optional - Whether or not the watermark_text will be displayed.
- **watermark_text** (string) - Optional - This text will be displayed over PDFs and images when the customer downloads them.
- **redirect_link** (string) - Optional - Redirect link string, the customer will be redirected to this link after purchase.

### Request Example
```json
{
  "title": "Software Activation Keys",
  "price": 12.5,
  "description": "Product description example.",
  "currency": "EUR",
  "gateways": [
    "PAYPAL",
    "STRIPE",
    "BITCOIN"
  ],
  "type": "SERIALS",
  "serials": [
    "activation-key-#1"
  ]
}
```

### Response
#### Success Response (200)
- **uniqid** (string) - The unique identifier for the created product.

#### Response Example
```json
{
  "uniqid": "prod_12345abcde"
}
```
```

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

### GET /blacklists

Source: https://developers.paylix.gg/index

Returns a list of all blacklist entries, sorted by creation date.

```APIDOC
## GET /blacklists

### Description
Returns a list of the Blacklist entries, sorted by creation date in descending order.

### Method
GET

### Endpoint
`/blacklists`

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **data.blacklists** (array) - An array of blacklist objects.

#### Response Example
```json
{
  "status": 200,
  "data": {
    "blacklists": [
      {
        "id": 0,
        "uniqid": "sample29a0e39d",
        "scope": "PRIVATE",
        "shop_id": 0,
        "type": "EMAIL",
        "data": "example@gmail.com",
        "note": "Blocking unwanted email.",
        "created_at": 162857125819,
        "updated_at": 162857125819,
        "updated_by": 0
      }
    ]
  },
  "message": null,
  "log": null,
  "error": null,
  "env": "production"
}
```
```

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

### Product Querystrings

Source: https://developers.paylix.gg/index

Enables merchants to create pre-configured product links with various parameters to customize the checkout experience.

```APIDOC
## Product Querystrings

### Description
Merchants can share links to their products with added querystring parameters to customize the checkout process. These parameters can pre-fill information such as quantity, payment gateway, and checkout step.

### Endpoint Format
`https://yourStore.mypaylix.gg/product/{productId}?parameter1=value1&parameter2=value2`

### Available Querystring Parameters
- **quantity** (integer) - Optional - Specifies the number of the same product to purchase.
- **gateway** (string) - Optional - Specifies which payment gateway should be selected (e.g., `LITECOIN`).
- **step** (integer) - Optional - Specifies which step of the checkout process should be displayed.
  - `0`: Default checkout step (product details)
  - `1`: Gateway choice step
  - `3`: Email and pay button step
- **email** (string) - Optional - The customer's email address.
- **couponCode** (string) - Optional - The code of a coupon to be applied automatically.
- **[customFieldName]** (any) - Optional - Any other added parameters will be passed as invisible custom fields to the invoice creation process.

### Example
`https://exampleStore.mypaylix.gg/product/demode8a50?quantity=5&gateway=LITECOIN&step=1&customFieldName=Paylix`
```

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

### GET /blacklists/:uniqid

Source: https://developers.paylix.gg/index

Retrieves a specific blacklist entry by its unique identifier.

```APIDOC
## GET /blacklists/:uniqid

### Description
Retrieves a Blacklist by its unique ID.

### Method
GET

### Endpoint
`/blacklists/:uniqid`

### Parameters
#### Path Parameters
- **uniqid** (string) - Required - The unique identifier of the blacklist entry.

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

#### Response Example
```json
{
  "status": 200,
  "data": {
    "blacklist": {
      "id": 0,
      "uniqid": "sample29a0e39d",
      "scope": "PRIVATE",
      "shop_id": 0,
      "type": "EMAIL",
      "data": "example@gmail.com",
      "note": "Blocking unwanted email.",
      "created_at": 162857125819,
      "updated_at": 162857125819,
      "updated_by": 0
    }
  },
  "message": null,
  "log": null,
  "error": null,
  "env": "production"
}
```
```

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

### Subscriptions API

Source: https://developers.paylix.gg/index

Manage subscriptions. You can get, list, create, and delete subscriptions.

```APIDOC
## Subscriptions

### Subscription Object
Represents a subscription.

### Get a Subscription
Retrieves a specific subscription.

### List All Subscriptions
Retrieves a list of all subscriptions.

### Create a Subscription
Creates a new subscription.

### Delete a Subscription
Deletes a subscription.
```

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

### License Product API

Source: https://developers.paylix.gg/index

Manage license products, including setting hardware IDs and checking licenses.

```APIDOC
## License Product

### Features
- Set Hardware ID
- Check License

### Set Hardware ID
Sets the hardware ID for a license.

### Check License
Checks the status of a license.
```

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

### Customers API

Source: https://developers.paylix.gg/index

Manage customers. You can get, list, create, and edit customers.

```APIDOC
## Customers

### Customer Object
Represents a customer.

### Get a Customer
Retrieves a specific customer.

### List All Customers
Retrieves a list of all customers.

### Create a Customer
Creates a new customer.

### Edit Customer
Edits an existing customer.
```

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

### Orders API

Source: https://developers.paylix.gg/index

Manage orders. You can get, update, replace, and list all orders.

```APIDOC
## Orders

### Order Object
Represents a customer order.

### Get an Order
Retrieves a specific order.

### Update Order
Updates an existing order.

### Replace Order
Replaces an existing order.

### List All Orders
Retrieves a list of all orders.
```

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

### Delete Product Example - PHP

Source: https://developers.paylix.gg/index

Demonstrates how to delete a product using the Paylix PHP SDK. It requires your API key, merchant name, and the unique identifier of the product to be deleted. Handles potential Paylix exceptions during the deletion process.

```php
<?php
  use \Paylix\PhpSdk\Paylix;
  use \Paylix\PhpSdk\PaylixException;

  $paylix = new Paylix("<YOUR_API_KEY>", "<MERCHANT_NAME>");
  $product_uniqid = "<PRODUCT_UNIQID>";

  try {
    $paylix->delete_product($product_uniqid);
  } catch (PaylixException $e) {
    echo $e->__toString();
  }
?>
```

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

### Feedback API

Source: https://developers.paylix.gg/index

Manage customer feedback. You can get, list, and reply to feedback.

```APIDOC
## Feedback

### Feedback Object
Represents customer feedback.

### Get a Feedback
Retrieves a specific feedback entry.

### List Feedback
Retrieves a list of all feedback entries.

### Reply Feedback
Replies to a feedback entry.
```

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

### Products API

Source: https://developers.paylix.gg/https%3A/dashboard

Manage products in the catalog. This includes retrieving, creating, updating, and deleting products.

```APIDOC
## Product Object

### Description
Represents a product in the catalog.

### Method
GET

### Endpoint
`/products/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the product.
- **name** (string) - The name of the product.
- **description** (string) - A description of the product.
- **price** (number) - The price of the product.
- **category_id** (string) - The identifier of the product's category.

#### Response Example
```json
{
  "id": "prod_abc123",
  "name": "Wireless Mouse",
  "description": "Ergonomic wireless mouse with long battery life.",
  "price": 25.99,
  "category_id": "cat_abc123"
}
```

## List All Products

### Description
Retrieves a list of all available products.

### Method
GET

### Endpoint
`/products`

### Parameters
#### Query Parameters
- **category_id** (string) - Optional - Filter products by category ID.
- **search**
```