Avalex Products API — Create, Read, Update, Delete

The /products resource represents the software titles, plugins, and services you sell and manage through Avalex. Each product record defines how licensing works — whether a license is required, whether billing recurs on a schedule, the default number of IP addresses and hardware IDs (HWIDs) permitted per license, and optional marketplace resource IDs (such as BuiltByBit). When a license is issued for a product, it inherits these defaults unless overridden at the license level.

Required Permissions

Action	Permission
List / retrieve products	`products:read`
Create / update products	`products:write`
Delete products	`products:delete`

List All Products

string

required

Bearer <token> or Basic credentials.

Returns an array of all product records in your catalog.

curl http://localhost:8080/products \
  -H "Authorization: Bearer <token>"

Response — 200 OK

[
  {
    "id": "prod_123",
    "name": "Enterprise Suite",
    "productType": "software",
    "builtByBitResourceId": "12345",
    "description": "Full desktop application",
    "price": 299.99,
    "requiresLicense": true,
    "isSubscription": true,
    "recurringPeriodDays": 365,
    "maxIps": 5,
    "maxHwids": 2,
    "createdAtEpochMillis": 1723140000000
  }
]

Create a Product

string

required

Bearer <token> or Basic credentials.

string

required

Display name of the product.

string

required

Category of the product, such as software, addon, or service.

string

Optional BuiltByBit Resource ID (e.g. 12345). Used by the automated BuiltByBit license placeholder webhook to match downloads to this product.

string

Human-readable description of the product.

number

required

Price in your account’s base currency.

boolean

required

Whether customers must have a valid license to use this product.

boolean

required

Whether this product is billed on a recurring schedule (Payment Mode).

integer

Number of days between billing cycles. Only relevant when isSubscription is true.

integer | null

Default maximum number of IP addresses a license for this product may be bound to. Set to null for unlimited.

integer | null

Default maximum number of hardware IDs a license for this product may be bound to. Set to null for unlimited.

Creates a new product and returns the created record.

curl -X POST http://localhost:8080/products \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Enterprise Suite",
    "productType": "software",
    "builtByBitResourceId": "12345",
    "description": "Full desktop application",
    "price": 299.99,
    "requiresLicense": true,
    "isSubscription": true,
    "recurringPeriodDays": 365,
    "maxIps": 5,
    "maxHwids": 2
  }'

Response — 201 Created

{
  "id": "prod_123",
  "name": "Enterprise Suite",
  "productType": "software",
  "builtByBitResourceId": "12345",
  "description": "Full desktop application",
  "price": 299.99,
  "requiresLicense": true,
  "isSubscription": true,
  "recurringPeriodDays": 365,
  "maxIps": 5,
  "maxHwids": 2,
  "createdAtEpochMillis": 1723140000000
}

Get a Product by ID

string

required

The unique product ID (e.g. prod_123).

Returns a single product record. Responds with 404 Not Found if no product with that ID exists.

curl http://localhost:8080/products/prod_123 \
  -H "Authorization: Bearer <token>"

Response — 200 OK

{
  "id": "prod_123",
  "name": "Enterprise Suite",
  "productType": "software",
  "builtByBitResourceId": "12345",
  "description": "Full desktop application",
  "price": 299.99,
  "requiresLicense": true,
  "isSubscription": true,
  "recurringPeriodDays": 365,
  "maxIps": 5,
  "maxHwids": 2,
  "createdAtEpochMillis": 1723140000000
}

Update a Product

string

required

The unique product ID.

Performs a full replacement of the product record. You must include all fields you want to retain — omitted fields will be cleared. Returns 404 Not Found if the product does not exist.

Changing maxIps, maxHwids, or builtByBitResourceId on a product does not retroactively alter existing licenses. Only new licenses inherit updated defaults.

curl -X PUT http://localhost:8080/products/prod_123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Enterprise Suite",
    "productType": "software",
    "builtByBitResourceId": "12345",
    "description": "Full desktop application — v2",
    "price": 349.99,
    "requiresLicense": true,
    "isSubscription": true,
    "recurringPeriodDays": 365,
    "maxIps": 10,
    "maxHwids": 4
  }'

Response — 200 OK

{
  "id": "prod_123",
  "name": "Enterprise Suite",
  "productType": "software",
  "builtByBitResourceId": "12345",
  "description": "Full desktop application — v2",
  "price": 349.99,
  "requiresLicense": true,
  "isSubscription": true,
  "recurringPeriodDays": 365,
  "maxIps": 10,
  "maxHwids": 4,
  "createdAtEpochMillis": 1723140000000
}

Delete a Product

string

required

The unique product ID.

Permanently removes the product record. Returns 204 No Content on success and 404 Not Found if the ID does not exist.

curl -X DELETE http://localhost:8080/products/prod_123 \
  -H "Authorization: Bearer <token>"

Response — 204 No Content

Product Schema

Show Product fields

string

Unique identifier assigned by Avalex on creation (e.g. prod_123).

string

Display name of the product as shown in the dashboard and API responses.

string

Category string describing the kind of product (e.g. software, addon, service).

string | null

Optional BuiltByBit Resource ID configured for automatic license fulfillment upon download.

string

Human-readable description of what the product includes or does.

number

Product price in your account’s base currency.

boolean

When true, customers must hold a valid Avalex license to use this product.

boolean

When true, this product is billed on a recurring schedule defined by recurringPeriodDays.

integer

Number of days in each billing cycle. Applicable only when isSubscription is true.

integer | null

Default maximum number of IP addresses a license for this product may bind to. null means unlimited. This value is inherited by newly issued licenses.

integer | null

Default maximum number of hardware IDs a license for this product may bind to. null means unlimited. This value is inherited by newly issued licenses.

number

Unix timestamp in milliseconds representing when this product was created.

Full Schema Example

{
  "id": "prod_123",
  "name": "Enterprise Suite",
  "productType": "software",
  "builtByBitResourceId": "12345",
  "description": "Full desktop application",
  "price": 299.99,
  "requiresLicense": true,
  "isSubscription": true,
  "recurringPeriodDays": 365,
  "maxIps": 5,
  "maxHwids": 2,
  "createdAtEpochMillis": 1723140000000
}

Authentication

License Validation

Resources

Staff & Admin

Audit Logs

Avalex Products API — Create, Read, Update, Delete

Required Permissions

List All Products

Create a Product

Get a Product by ID

Update a Product

Delete a Product

Product Schema

Full Schema Example

​Required Permissions

​List All Products

​Create a Product

​Get a Product by ID

​Update a Product

​Delete a Product

​Product Schema

​Full Schema Example

Required Permissions

List All Products

Create a Product

Get a Product by ID

Update a Product

Delete a Product

Product Schema

Full Schema Example