Commet
  • Pricing
Log InTry out
Cancel subscription POSTChange plan POSTCreate subscription POSTGet active subscription GETList subscriptions GET
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Cancel subscription

Cancel immediately or at period end.

Set seats PUT

Set seats to an exact count.

Change plan POST

Upgrade, downgrade, or change billing interval.

POST
/subscriptions/{id}/cancel

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Response Body

application/json

application/json

curl -X POST "https://commet.co/api/subscriptions/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'

application/json

Cancel immediately or at period end.

Subscription public ID

{
  "success": true,
  "data": {
    "id": "string",
    "customerId": "string",
    "status": "string",
    "canceledAt": "string",
    "cancelReason": "string",
    "endDate": "string",
    "updatedAt": "2019-08-24T14:15:22Z"
  }

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