Skip to main content
Creates a new project under the authenticated user’s account.

​
Endpoint

POST /api/v1/projects

​
Authentication

​
Authorization
string
required
Bearer token with your API key. Requires read_write permission.

​
Body Parameters

​
name
string
required
Project name. Maximum 100 characters.
​
description
string
Short description of the project.
​
pricingPageDescription
string
Longer description shown on the pricing page header.
​
currency
string
default:"USD"
Currency code for pricing (e.g. "USD", "EUR", "GBP").

​
Response

Returns the full project object with status 201 Created.
​
id
number
Unique project ID
​
name
string
Project display name
​
slug
string
Auto-generated URL-friendly identifier
​
description
string
Short project description
​
pricingPageDescription
string
Pricing page header description
​
shareId
string
Public share identifier for the embed widget
​
currency
string
Currency code
​
isActive
boolean
Whether the project is active (defaults to true)
​
createdAt
string
ISO 8601 creation timestamp
​
updatedAt
string
ISO 8601 last-updated timestamp

​
Example

curl -X POST https://cuprice.io/api/v1/projects \
  -H "Authorization: Bearer cpk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My SaaS App",
    "description": "AI-powered project management tool",
    "pricingPageDescription": "Simple, transparent pricing for teams of all sizes.",
    "currency": "USD"
  }'

{
  "id": 42,
  "name": "My SaaS App",
  "slug": "my-saas-app",
  "description": "AI-powered project management tool",
  "pricingPageDescription": "Simple, transparent pricing for teams of all sizes.",
  "shareId": "nTZ7axXQHU",
  "currency": "USD",
  "isActive": true,
  "createdAt": "2025-09-15T10:30:00.000Z",
  "updatedAt": "2025-09-15T10:30:00.000Z"
}

​
Errors

StatusDescription
400Missing name or name exceeds 100 characters
401Invalid or missing API key
403API key does not have read_write permission