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

Remove seats

Remove seats from a customer's subscription. Takes effect at the end of the billing period.

Get seat balance GET

Get current balance for a specific seat type.

Set seats PUT

Set seats to an exact count.

DELETE
/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 DELETE "https://commet.co/api/seats" \  -H "Content-Type: application/json" \  -d '{    "customerId": "string",    "seatType": "string",    "count": 0  }'

application/json

Remove seats from a customer's subscription. Takes effect at the end of the 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
}
}