Commet
  • Pricing
Log InTry out
Add seats POSTBulk set seats PUTGet all seat balances GETGet seat balance GETRemove seats DELETESet seats PUT
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Add seats

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

Request portal access POST

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

Bulk set seats PUT

Set all seat types at once.

POST
/seats

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId*string
1 <= length <= 200
seatType*string
^[a-z0-9_]+$
1 <= length <= 50
count*integer
0 < value
Length
Match
Length
Range

Response Body

application/json

application/json

curl -X POST "https://commet.co/api/seats" \  -H "Content-Type: application/json" \  -d '{    "customerId": "string",    "seatType": "string",    "count": 0  }'

application/json

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

{
  "success": true,
  "data": {
    "id": "string",
    "customerId": "string",
    "seatType": "string",
    "previousBalance": 0,
    "newBalance": 0,
    "ts": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  }

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