API ReferenceEnrollments

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 organization API-key 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.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Path parameters

enrollment_idstringRequired

Unique enrollment identifier (enrl_*)

Headers

X-Vitable-OrganizationstringOptional
Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.

Request

This endpoint expects an object.
reasonstring or nullOptional

Audit reason for the termination; required for user-backed callers and optional for long-lived organization API-key callers

ticket_numberstring or nullOptional<=1000 characters
Optional support or operational ticket number
qualifying_life_event_idstring or nullOptional

Accepted member qualifying life event identifier (qle_*)

Response

No response body

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error