Commet
  • Pricing
Log InTry out
Get plan GETList plans GET
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

List plans

List all plans with their prices and features. Optionally include private plans.

Get plan GET

Get detailed plan information by code or ID.

Request portal access POST

Generate a customer portal URL. Exactly one identifier (email, customerId, or externalId) is required.

GET
/plans

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

includePrivate?string

Response Body

application/json

curl -X GET "https://commet.co/api/plans"

List all plans with their prices and features. Optionally include private plans.

Set to 'true' to include private plans

{
  "success": true,
  "data": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "description": "string",
      "isPublic": true,
      "isFree": true,
      "isDefault": true,
"sortOrder": 0,
"prices": [
{
"billingInterval": "string",
"price": 0,
"isDefault": true,
"trialDays": 0
}
],
"features": [
{
"code": "string",
"name": "string",
"type": "string",
"enabled": true,
"includedAmount": 0,
"unlimited": true,
"overageEnabled": true,
"overageUnitPrice": 0
}
],
"createdAt": "2019-08-24T14:15:22Z"
}
]
}