Create a license

Issue a new license key for a project. This endpoint creates a new license and returns the license key you will share with your customer or SDK user.

Endpoint

POST /project/{project}/licenses

Full URL:

https://api.devpayr.dev/api/v1/project/{project}/licenses

Authentication

✅ Required: API Key

Send your API key using:

X-API-KEY: <your_api_key>

Path Parameters

Parameter	Type	Required	Description
project	integer	Yes	The ID of the project to issue the license for.

Request Format

• Content-Type: application/json

• Accept: application/json

Request Body

Required Fields

Field	Type	Required	Description
title	string	✅	A human-friendly name for the license (must be unique within the project).

Optional Fields

Field	Type	Required	Description
domain_id	integer | null	No	Attach this license to a specific project domain (domain must already exist on the project).
expires_at	string | null	No	Expiration date/time (must be a future date).
max_domains	integer | null	No	Maximum number of domains allowed for this license.
max_subdomains_per_domain	integer | null	No	Maximum number of subdomains allowed per base domain.
max_usage_per_day	integer | null	No	Maximum daily usage allowed for this license.
allowed_ips	string | null	No	Comma-separated IPs allowed to use this license. Example: "127.0.0.1, 102.90.101.2"
allowed_countries	string | null	No	Comma-separated 2-letter country codes allowed. Example: "NG, US, GB"
is_test_license	boolean	No	Marks the license as a test license.
allow_configs	boolean	No	Allows the license to accept configuration options at runtime

If you don’t provide optional fields, DevPayr will apply safe defaults based on your account configuration.

Example Request

curl -X POST "https://api.devpayr.dev/api/v1/project/2/licenses" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d '{
    "title": "Regular",
    "expires_at": "2026-12-31T23:59:59Z",
    "max_domains": 6,
    "max_subdomains_per_domain": 1,
    "max_usage_per_day": 1000,
    "allowed_ips": "127.0.0.1, 102.90.101.2",
    "allowed_countries": "NG, US",
    "is_test_license": false,
    "allow_configs": false
  }'

---

Response

Success (201)

Returns the newly created license. The license key you should use/share is:

✅ uuid

Example Response

{
    "status": "success",
    "message": "License key has been issued successfully.",
    "data": {
        "id": 3,
        "uuid": "019b17ae-09be-72e2-886a-ee2a6ec07af8",
        "title": "Regular License",
        "expires_at": "2026-12-31T23:59:59.000000Z",
        "max_domains": 6,
        "max_subdomains_per_domain": 1,
        "max_usage_per_day": 1000,
        "is_test_license": false,
        "allow_configs": false,
        "allowed_ips": [
            "127.0.0.1",
            "102.90.101.2"
        ],
        "allowed_countries": [
            "NG",
            "US"
        ],
        "validate_against": "license_domains",
        "domain_id": null,
        "created_at": "2025-12-13T12:27:20.000000Z",
        "updated_at": "2025-12-13T12:27:20.000000Z"
    },
    "errors": null
}

Validation Rules

title

• required

• max length: 255

• must be unique within the project

domain_id

• must reference an existing project domain

• if invalid:

{ "message": "The selected domain is invalid." }

expires_at

• must be a valid date

• must be in the future:

{ "message": "Expiration must be a future date." }

Limits

These must be integers and must be 0 or greater:

• max_domains

• max_subdomains_per_domain

• max_usage_per_day

Errors

Missing API Key (401)

{ "message": "Missing required X-API-KEY header." }

Invalid / Expired API Key (403)

{ "message": "Invalid or expired API key." }

Not allowed / plan restriction (403)

{ "message": "You are not authorized to issue licenses for this project using this API key." }

Or (project mismatch / ownership):

{ "message": "This API key is not allowed to issue licenses for this project." }

{ "message": "This API key does not have permission to manage this project." }

Validation failed (422)

Example:

{ "message": "Expiration must be a future date." }

Project Not Found (404)

{ "message": "Resource not found." }

Rate Limited (429)

{ "message": "Too many requests. Please slow down." }