Example

{
  "object": "contract_cancellation_request",
  "id": "af2b1f7d-bd8f-419b-8413-39952e5f9d31",
  "contract_id": "d516c361-3e50-42b2-b1e1-3723910146ae",
  "reason": "other",
  "other_reason": "a reason for requesting a cancellation",
  "reason_event_date": "2023-09-01T15:07:56.572316Z",
  "final_reason": "policyholder_status_change",
  "status": "approved",
  "source": "policyholder",
  "created_at": "2023-12-19T15:02:57.499435Z",
  "updated_at": "2023-12-19T15:02:57.499435Z",
  "refund_amount": 1000,
  "refund_currency": "EUR",
  "refundable_charges": [
    {
      "charge_id": "4da0b087-b543-4f1b-b35f-a1ed6da33c4f",
			"charge_external_id": "external-id",
      "refund_amount": 499
    }
  ]
}

Attributes

field	type	description
object	string, value is `"contract_cancellation_request"`	String representing the object’s type. Objects of the same type share the same value.
id	string	Unique identifier for the contract cancellation request.
contract_id	string	Unique identifier for the contract whose cancellation is requested.
reason	enum, possible values are listed here	The reason provided by the policyholders when requesting the cancellation of their contracts.
other_reason	nullable string	A free text describing the reason of the cancellation when none of the reasons fit the policyholder case. Required when `reason` is set to `other`.
reason_event_date	nullable timestamp	Time at which the event that initiated the cancellation request happened. Formatted as a RFC 3339 timestamp.
final_reason	nullable enum, possible values are listed here	The final reason leading to the approval of the cancellation request and the cancellation of the contract. The final reason is decided by the Operations team at Evy while cancelling a contract.
status	enum, possible values are `"pending"`, `"approved"`, `"denied"` and `"withdrawn"`	The status of the contract cancellation request.
source	enum, possible values are `"policyholder"` and `"evy"`	The source of the contract cancellation request. Such a request can either come from the policyholder, either from Evy (i.e. when a claim compensation leads to the cancellation of the contract).
created_at	timestamp	Time at which the request was created. Formatted as a RFC 3339 timestamp.
updated_at	timestamp	Time at which the request was last updated. Formatted as a RFC 3339 timestamp.
refund_amount	integer	Positive integer representing the amount to refund in cents.
refund_currency	string	Three-letter ISO4217 currency code, in uppercase.
refundable_charges	array of RefundableCharge

RefundableCharge

field	type	description
charge_id	string	Unique identifier of the refundable charge.
refund_amount	integer	Positive integer representing the amount to refund in cents.

Cancellation reasons

Cancellation reasons that are specific to the policyholder and can be used to create contract cancellation requests:

reason	description
`withdrawal`	The policyholder cancels their contract during the withdrawal period.
`product_order_abandon`	The policyholder never received the product or they returned it.
`already_insured`	The policyholder's product was already insured.
`insured_product_loss`	The policyholder's product has been lost.
`insured_product_stolen`	The policyholder's product has been stolen.
`insured_product_sold`	The policyholder's product has been sold.
`insured_product_warranty_returned`	The policyholder's product was returned under warranty.
`termination_upon_expiry`	The policyholder wishes to cancel their contract at the anniversary date of the contract.
`termination_after_first_year`	The policyholder wishes to cancel their contract at any moment after the anniversary date of the contract.
`termination_upon_rental_end`	The policyholder has returned their rented or leased products and wishes to terminate the associated contract.
`policyholder_status_change`	The policyholder personal situation has changed.
`other`	Another reason describing a case not handled in this list.

Cancellation reasons that can only be set by Evy or the insurer and cannot be used to create contract cancellation requests, but could be set as the final_reason in a contract_cancellation_request.approved event:

reason	description
`commercial_action`	Commercial action toward the policyholder.
`ownership_transfer`	Evy canceled the contract after the policyholder sold or gave the insured product.
`insured_product_requisition`	The contract was cancelled following a requisition of the insured product by the authorities.
`unpaid_premium`	The policyholder did not pay the premium of his contract and it was cancelled.
`risk_increase`	A change of circumstances increased the risk and the insurer decided to cancel the contract.
`termination_after_claim`	The policyholder's contract was cancelled following a claim.
`single_claim_compensated`	The policyholder's contract was cancelled following a claim, as the policy limited coverage to one claim only.
`claim_amount_exceeded`	The policyholder's contract was cancelled following a claim which reached the policy coverage limit.
`past_due`	The policyholder failed to pay for their premiums.
`dispute`	The policyholder claimed back their contract premium following a payment dispute.
`termination_on_insurer_demands`	The insurer ends the policy one month after a claim, as allowed by a special clause in the contract.
`termination_insurer_withdrawn`	The insurer decided to stopped the program and we didn't find another one to take over
`termination_after_fraud`	The customer lied or omitted voluntarily some information about their claim.
`termination_after_policy_terminated_by_insurer`	Evy terminated one contract after a claim of this customer and they wish to cancel all their others in reaction
`termination_due_to_coverage_limit`	The customer made a claim that was successfully processed ; their contract only allowed one which correspond to rented/leased products.