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

Endpoint

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

Errors