Retrieve a license

Fetch the details of a single license that belongs to a project.

This endpoint is useful when you want to:

• view license configuration (domain limits, usage limits, test/prod mode, etc.)

• confirm license status before revoking/reactivating

• build a dashboard “license details” page

Endpoint

GET /project/{project}/licenses/{license}

Full URL:

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

Authentication

✅ Required: API Key

Send your API key using:

X-API-KEY: <your_api_key>

This endpoint does not accept license authentication.

Path Parameters

Parameter	Type	Required	Description
project	integer	Yes	The ID of the project.
license	integer	Yes	The ID of the license record (not the license key string).

Access Rules

DevPayr enforces access in this order:

1) The license must belong to the project

If the {license} you passed is not part of the {project}, DevPayr returns a 404.

Error (404)

{ "message": "License does not belong to this project." }

2) Project-scoped API key must match the project

If your API key is scoped to a specific project, it must match {project}.

Error (403)

{ "message": "This API key cannot access this license." }

3) Global API key must match project ownership

If your API key is global, it must belong to the project owner.

Error (403)

{ "message": "You do not have access to this project." }

Example Request

curl -X GET "https://api.devpayr.dev/api/v1/project/2/licenses/1" \
  -H "Accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"

Response

Success (200)

DevPayr returns the license record in the standard response envelope.

Example Response

{
  "status": "success",
  "message": "Success",
  "data": {
    "id": 2,
    "project_id": 2,
    "domain_id": null,
    "title": "Regular",
    "uuid": "019ae565-2115-7172-8729-9e48df5c113d",
    "is_active": true,
    "expires_at": null,
    "max_domains": "6",
    "is_unlimited_domains": false,
    "is_unlimited_subdomains": false,
    "is_test_license": false,
    "allowed_ips": null,
    "allowed_countries": null,
    "allow_ui_update": true,
    "allow_configs": false,
    "last_verified_at": null,
    "max_subdomains_per_domain": "1",
    "max_usage_per_day": "1",
    "issued_from_ip": "102.90.101.2",
    "meta": [],
    "created_at": "2025-12-03T18:06:41.000000Z",
    "updated_at": "2025-12-03T18:06:41.000000Z"
  },
  "errors": null
}

What is the Actual License Key?

In DevPayr, the value that the customer/SDK uses as the license key is:

✅ uuid

Example:

"uuid": "019ae565-2115-7172-8729-9e48df5c113d"

That is what can be sent as:

• X-LICENSE-KEY: <uuid>

• or license=<uuid> in the query/body (depending on the endpoint)

Hidden Fields

This endpoint hides internal fields that should never be exposed publicly:

• uuid_hash (stored hashed license)

• validate_against (internal enforcement mode field)

• user_id (internal owner id)

Everything else is returned as part of the license record.

Caching Behavior

This endpoint caches the response:

• Cache TTL: 15 minutes

• Cache key includes:

  • API key ID

  • project ID

  • license ID

This makes repeated dashboard reads faster.

Errors

Missing API Key (401)

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

Invalid / Expired API Key (403)

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

Unauthorized (403)

Project-scoped mismatch:

{ "message": "This API key cannot access this license." }

Global key not owner:

{ "message": "You do not have access to this project." }

License Not Found / Not in Project (404)

Wrong project-license pairing:

{ "message": "License does not belong to this project." }

Generic not found:

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

Rate Limited (429)

{ "message": "Rate limit exceeded (X requests/min). Please slow down." }