Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Enrollments

Terminate an enrollment

enrollments.terminate(enrollment_id, **kwargs) -> void
POST/v1/enrollments/{enrollment_id}/terminate

Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. User-backed callers must provide a reason; it is optional for userless organization callers. API keys may act across the caller organization’s book. Tenant mismatches return the same non-disclosing 404 before the request body is validated.

ParametersExpand Collapse
enrollment_id: String

Unique enrollment identifier (enrl_*)

qualifying_life_event_id: String

Accepted member qualifying life event identifier (qle_*)

reason: String

Audit reason for the termination; required for user-backed callers and optional for userless organization callers

ticket_number: String

Optional support or operational ticket number

maxLength1000

Terminate an enrollment

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

result = vitable_connect.enrollments.terminate("enrl_AAAAAAAAAAAAAAAAAAAAAQ")

puts(result)
Returns Examples