Cancel a seat

Schedules a seat for cancellation at the end of the current period. Already scheduled: returns the existing effective date. Already effective: 400 ALREADY_CANCELLED.

post/v1/billing/seats/{seat_id}/cancel

Request

Base URL: https://api.curviate.com
URL: https://api.curviate.com/v1/billing/seats/{seat_id}/cancel
Auth: HTTP bearer

Path parameters

seat_idstring required

The seat ID (seat_...) to cancel.

Response

Cancellation scheduled (or already was).

effective_atstring date-time required

When the seat's access ends.

Example response

{
  "safety_warning": {
    "row": "profile_views",
    "reset_at": "2026-09-05T00:00:00.000Z",
    "hint": {
      "parameter": "profile_views.ceiling",
      "message": "This account is at its ceiling for profile_views. This action went through because profile_views.posture is warn, and it counted: 101 of 100 this window. Raise profile_views.ceiling, or wait for the window to reset at 2026-09-05T00:00:00.000Z."
    },
    "reason": "ceiling",
    "blocked": false
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.