Added

0.19.5 Contract bundle cancellation

You can now cancel coverage directly through the API — either a whole contract bundle or a single dependant within one.

New endpoints

Cancel a contract bundle

POST /api/remote-health/v1/contract-bundles/{contractBundleId}/cancel

Cancels the entire bundle — the planholder and all dependants — effective on the provided date.

Cancel a single contract holder

POST /api/remote-health/v1/contract-bundles/{contractBundleId}/contract-holders/{contractHolderId}/cancel

Cancels one dependant's contracts within a bundle, effective on the provided date. The rest of the bundle stays active. The planholder cannot be cancelled individually — cancelling the planholder ends the whole bundle, so use the bundle cancellation endpoint for that.

Request body

Both endpoints take the same body:

{
  "reason": "Change in employment status",
  "date": "2026-09-01"
}
  • reason — must be one of your company's valid cancellation reasons.
  • date — the date the cancellation takes effect.

Returns 200 on success, 400 for an invalid reason or date, and 404 if the contract bundle (or contract holder) is not found.

See the Contract Bundles reference for full details.