Skip to main content
Returns all public data about a project — name, plans, features, prices, and theme settings.
This is the same data the embed widget uses internally.

Endpoint

Parameters

string
required
The project’s Share ID

Response

number
Project ID
string
Project display name
string
Short description
string
Longer description for the pricing page header
string
The Share ID
string
Currency code (e.g. “USD”)
number
Discount for annual billing (e.g. 0.2 = 20% off)
boolean
Whether the page offers annual billing with that discount
boolean
Whether the project has a checkout link. The link itself is never returned.
array
Plans that are visible on the page, in page order. Each has id (the cuprice_plan_id sent to your checkout), name, description, basePrice, isFree, isPopular and planFeatures.
array
The plan’s features. Each has featureId, multiplier and feature (id, name, featureType, basePrice). A feature is in the plan when multiplier is above 0. For a feature with usage settings (countableData below), multiplier is the plan’s limit.
array
All features in the project, with id, name, featureType, basePrice and countableData (usageCount, countPrice, condition) or null
object
Colors, fonts, CSS, layout settings

Example

The example is trimmed: plans and features also carry IDs, timestamps and display fields, and the response includes themeSettings. A Share ID that does not exist returns 404 with "error": "Project not found".