Create a project

Create a new project using a global API key.

Projects are the top-level containers in DevPayr. After creating a project, you can manage:

• project domains

• licenses

• injectables

• payment enforcement state (has_paid)

Endpoint

POST /project

Full URL:

https://api.devpayr.dev/api/v1/project

Authentication

✅ Required: API Key

Send your API key using:

X-API-KEY: <your_api_key>

Important Rules

Only global API keys may create projects

If your API key is scoped to a specific project (project_id is set on the API key), DevPayr will reject the request.

Error (403)

{ "message": "Only global API keys may create projects." }

Plan limits are enforced before validation

Project creation is limited by the subscription plan of the API key owner.

If you have reached your plan’s maximum allowed projects, DevPayr blocks the request.

Error (403)

{ "message": "You have reached the maximum number of projects allowed on your plan." }

Request Body

Send a JSON request body.

Fields

Field	Type	Required	Description
name	string	✅	Project name. Max length: 255.
slug	string	❌	Optional custom slug. Must be alpha_dash, max 255, and unique across projects. If omitted, DevPayr generates one automatically.
description	string	❌	Optional description. Max length: 1000.
default_redirect_url	string (url)	❌	Optional redirect URL used by your SDK/app when access is blocked or a license is not valid.
webhook_url	string (url)	❌	Optional webhook destination for project events (if enabled for the account).
webhook_secret	string	❌	Optional secret used for webhook security/verification (if webhooks are enabled).
logo_url	string (url)	❌	Optional logo URL for the project.
meta	object	❌	Optional metadata object. Must be a valid JSON object.
has_paid	boolean	❌	Optional payment flag for the project. Defaults to false if not provided.

Meta Field Notes

meta must be a JSON object.

✅ Valid:

{
  "meta": {
    "sdk_version": "1.3.2",
    "channel": "web"
  }
}

Also supported: sending meta as a JSON string — DevPayr will attempt to decode it before validation.

If decoding fails or the value is not an object, validation will fail.

Custom error message

{ "message": "The metadata (meta) must be a valid object." }

Example Request

curl -X POST "https://api.devpayr.dev/api/v1/project" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d '{
    "name": "My Dev SDK",
    "slug": "my-dev-sdk",
    "description": "This project handles SDK telemetry",
    "default_redirect_url": "https://myapp.com/expired",
    "webhook_url": "https://myapp.com/webhook",
    "webhook_secret": "my_webhook_secret",
    "logo_url": "https://myapp.com/logo.png",
    "meta": {
      "sdk_version": "1.3.2",
      "channel": "web"
    },
    "has_paid": false
  }'

Response

Success (201)

DevPayr returns a standard response envelope:

• status → success indicator

• message → human-readable success message

• data → the created project object

• errors → null on success

Example Response

{
  "status": "success",
  "message": "Project has been successfully created.",
  "data": {
    "id": 4,
    "name": "My Dev SDK",
    "slug": "my-dev-sdk",
    "description": "This project handles SDK telemetry",
    "default_redirect_url": "https://myapp.com/expired",
    "webhook_url": "https://myapp.com/webhook",
    "logo_url": "https://myapp.com/logo.png",
    "meta": {
      "sdk_version": "1.3.2",
      "channel": "web"
    },
    "is_active": true,
    "has_paid": false,
    "created_at": "2025-12-13T11:26:53.000000Z",
    "updated_at": "2025-12-13T11:26:53.000000Z"
  },
  "errors": null
}

Project Object Returned

Field	Type	Description
id	integer	Project ID
name	string	Project name
slug	string	Project slug
description	string | null	Optional description
default_redirect_url	string | null	Optional redirect destination
webhook_url	string | null	Optional webhook destination
logo_url	string | null	Optional logo URL
meta	object	Metadata payload
is_active	boolean	Whether the project is active
has_paid	boolean	Payment enforcement flag
created_at	string	ISO timestamp
updated_at	string	ISO timestamp

Validation Errors (422)

If validation fails, DevPayr returns a 422 response.

Common validation cases:

• name missing or too long

• slug not alpha_dash or already taken

• invalid URL fields (default_redirect_url, webhook_url, logo_url)

• meta is not an object

• has_paid is not a boolean

Notable custom validation messages

Slug already taken:

{ "message": "This project slug is already in use." }

Meta not an object:

{ "message": "The metadata (meta) must be a valid object." }

The full 422 response may include an errors object containing field-level details.

Errors

Missing API Key (401)

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

Invalid / Expired API Key (403)

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

Scoped API Key Not Allowed (403)

{ "message": "Only global API keys may create projects." }

Plan Limit Reached (403)

{ "message": "You have reached the maximum number of projects allowed on your plan." }

Validation Error (422)

{
    "message": "This project slug is already in use.",
    "errors": {
        "slug": [
            "This project slug is already in use."
        ]
    }
}

Rate Limited (429)

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