CLclaimmind
Subscriptions

Cancel Subscription

Cancel a tenant's subscription.

Supports two cancellation modes:

  • immediate: Terminates the subscription right away, generates final invoice
  • end_of_period: Subscription continues until the current billing period ends

Idempotent: cancelling an already-cancelled subscription returns 200.

Access: mtk_admin and super_admin (scoped to hospital group)

Request body:

{
    "effective": "immediate"
}
post/admin/tenants/{tenant_id}/subscription/cancel

Request

  • Base URL
    https://developer.claimmind.life (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: token

Path parameters

tenant_idstring required

Request body

effectivestring

Example request

{
  "effective": "immediate"
}

Response

Successful Response

cancelled_atstring date-time required
effective_datestring date-time required
messagestring

Example response

{
  "subscription": {
    "created_at": "2026-01-22T10:00:00Z",
    "ending_at": "2027-01-31T23:59:59Z",
    "external_id": "tenant-001",
    "lago_id": "sub-lago-uuid-456",
    "plan_code": "claim_mind_basic",
    "plan_name": "ClaimMind Basic",
    "started_at": "2026-02-01T00:00:00Z",
    "status": "active"
  }
}

Changes

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