Commet
  • Pricing
Log InTry out
Request portal access POST
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Request portal access

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

List plans GET

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

Add seats POST

Add seats to a customer's subscription. Prorates charges for the current billing period.

POST
/portal/request-access

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email?string
Formatemail
customerId?string
1 <= length <= 200
Length

Response Body

application/json

application/json

application/json

curl -X POST "https://commet.co/api/portal/request-access" \  -H "Content-Type: application/json" \  -d '{}'

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

{
  "success": true,
  "data": {
    "portalUrl": "string"
  }
}
{
  "success": false,
  "code": "string",
  "message": "string",
  "details": null
}
{
  "success": false,
  "code": "string",
  "message": "string",
  "details": null
}