Skip to main content
Returns a single project including its theme settings, features (with countable data), and pricing plans (with plan features and feature details).

​
Endpoint

GET /api/v1/projects/{slug}

​
Authentication

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

​
Path Parameters

​
slug
string
required
The project’s URL-friendly slug identifier.

​
Response

​
id
number
Unique project ID
​
name
string
Project display name
​
slug
string
URL-friendly project identifier
​
description
string
Short project description
​
pricingPageDescription
string
Pricing page header description
​
shareId
string
Public share identifier
​
currency
string
Currency code
​
annualDiscount
number
Discount percentage for annual billing (e.g. 0.2 = 20% off)
​
annualDiscountEnabled
boolean
Whether annual discount is enabled
​
isActive
boolean
Whether the project is active
​
themeSettings
object
Visual customization settings (colors, fonts, CSS, layout)
​
features
array
All features in the project, each including countableData for usage-based features
​
pricingPlans
array
All pricing plans, each including planFeatures with nested feature details

​
Example

curl https://cuprice.io/api/v1/projects/my-saas-app \
  -H "Authorization: Bearer cpk_your_key_here"

{
  "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",
  "annualDiscount": 0.2,
  "annualDiscountEnabled": true,
  "isActive": true,
  "themeSettings": {
    "fontFamily": "Inter",
    "primaryColor": "#298558",
    "hoverColor": "#1E6B44",
    "buttonTextColor": "#FFFFFF",
    "borderRadius": "8px",
    "pricingBackgroundColor": "#FFFFFF",
    "pricingBorderColor": "#E5E7EB",
    "customCSS": ""
  },
  "features": [
    {
      "id": 101,
      "name": "AI Prompts",
      "description": "Monthly AI prompt allowance",
      "basePrice": 10,
      "featureType": "Limits",
      "isCountable": true,
      "countableData": {
        "usageCount": 500,
        "condition": "Up to",
        "countPrice": 0.02,
        "eventAggregationMethod": "count"
      }
    },
    {
      "id": 102,
      "name": "Team Members",
      "description": "Number of team seats",
      "basePrice": 5,
      "featureType": "Standart",
      "isCountable": false,
      "countableData": null
    }
  ],
  "pricingPlans": [
    {
      "id": 200,
      "name": "Pro",
      "description": "For growing teams",
      "basePrice": 29,
      "isPopular": true,
      "isVisible": true,
      "isFree": false,
      "planFeatures": [
        {
          "id": 301,
          "multiplier": 1,
          "feature": {
            "id": 101,
            "name": "AI Prompts",
            "featureType": "Limits",
            "basePrice": 10
          }
        },
        {
          "id": 302,
          "multiplier": 5,
          "feature": {
            "id": 102,
            "name": "Team Members",
            "featureType": "Standart",
            "basePrice": 5
          }
        }
      ]
    }
  ]
}

​
Errors

StatusDescription
401Invalid or missing API key
404Project with the given slug not found