Create Termination Request

Unique identifier for the business entity. Required to scope the request to the correct organizational context.

Unique idempotency key to ensure safe retry of this non-idempotent POST operation. Provide the same UUID on retries of the same logical termination request to receive the same response without duplicate processing on the server.

Optional correlation ID associated with the request

Unique identifier (UUID v4) for the consumer whose plans are being terminated. This ID must match an existing consumer with active plans.

Operation mode for the termination request. PREVIEW validates the request and returns impact analysis without executing the termination (dry-run). EXECUTE validates and processes the termination request, creating the actual termination.

List of selected plan IDs to terminate. Can be empty if selected_bundle_ids or terminate_all_plans is provided instead. At least one of selected_plan_ids, selected_bundle_ids, or terminate_all_plans must be specified (cross-field validation enforced by API, not schema).

List of selected bundle IDs to terminate. Can be empty if selected_plan_ids or terminate_all_plans is provided instead. At least one of selected_plan_ids, selected_bundle_ids, or terminate_all_plans must be specified (cross-field validation enforced by API, not schema).

Requested termination date (ISO 8601 format)

Termination reason code

Optional notes about the termination

Whether to terminate all plans for the consumer. When true, selected_plan_ids and selected_bundle_ids are ignored. At least one of selected_plan_ids, selected_bundle_ids, or terminate_all_plans must be specified (cross-field validation enforced by API, not schema).

Processing mode for the termination request. SYNCHRONOUS processes the termination immediately and returns the result in the response. ASYNCHRONOUS queues the termination for background processing and returns immediately with PENDING status. Defaults to SYNCHRONOUS if not specified.

Indicates whether the termination request would be valid if executed. When false, validation_errors will contain specific reasons why the request cannot be processed.

Validation errors that would prevent the termination from being executed. Only populated when is_valid is false.

Non-blocking warnings about the termination impact. These do not prevent execution but inform the user of important consequences such as dependent coverage loss or mid-period termination fees.

Plans that would be terminated if this request is executed.

Dependents who would lose coverage if this termination is executed. Helps users understand the full impact on family members.

Unique identifier for the termination request

Unique identifier (UUID v4) for the consumer whose plans were terminated. Matches the consumer_id from the request.

Current processing status of the termination request. COMPLETED indicates successful termination, PENDING means queued for async processing, PROCESSING indicates active execution, and FAILED means the request encountered an error. Check detail in error responses for failure reasons.

Termination date (ISO 8601 format)

Plans that were terminated

Confirmation number for the termination. Can be provided to customer service for reference.

Timestamp when the request was created (RFC 3339 format in UTC)

Timestamp when the request was completed (RFC 3339 format in UTC)

Indicates whether background jobs for premium allocation adjustments were scheduled following this termination. When true, premium refunds or adjustments will be processed asynchronously. This is typically true for mid-period terminations requiring prorated refunds.

Hypermedia links for navigation and related actions

List of invalid parameters that caused the validation error.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

List of invalid parameters that caused the validation error.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

List of invalid parameters that caused the validation error.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

List of invalid parameters that caused the validation error.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

List of invalid parameters that caused the validation error.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

List of invalid parameters that caused the validation error.

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.