A contract is a resource created by Evy following the creation of a paid order or the payment of an order intent. It contains the terms of the purchased insurance policy.
Example contract object
{
"object": "contract",
"id": "afe2a217-65c4-4977-b0cd-bcf88fa5b8ce",
"customer_contract_id": "ABCDEFGHI",
"status": "activated",
"currency": "EUR",
"premium": 1199,
"cover_start_date": "2022-08-08T08:47:07.565677Z",
"cover_end_date": "2025-08-08T08:47:07.565677Z",
"cover_cancelled_date": null,
"cover_withdrawn_date": null,
"order_id": "order-45",
"purchased_at": "2022-07-15T01:21:38.045508Z",
"policy_title": "Extension panne + Casse",
"policy_id": "8144dea5-b2af-4615-b7df-dcfd43edc498",
"term_length": 36,
"insurer_contract_name": "ICIMOPC22",
"coverage": [
"adh",
"extended_warranty"
],
"recurring_interval": null,
"products": [
{
"title": "Dyson vacuum cleaner",
"category_id": 1,
"amount": 13999,
"purchased_at": "2022-07-15T01:21:38.045508Z",
"purchase_date": "2022-07-15"
}
],
"billing": {
"name": "Jane Doe",
"line1": "12 rue des tests",
"postal_code": "75002",
"city": "Paris",
"state": "Ile de France",
"country": "France",
"phone": "+33712457843"
},
"customer": {
"email": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"phone": "+33712457843"
},
"store_id": "24ac248d-7e62-4c19-bb13-02845b2f38a8",
"subscription_id": null
}Attributes
object | string, value is | String representing the object’s type. Objects of the same type share the same value. |
id | string | Unique identifier (UUID) of the contract. |
customer_contract_id | string | The customer contract id. This is the reference displayed in the subscription certificate. |
status | enum, possible values are | The status of the contract. |
currency | string | Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency. |
premium | integer | A positive integer representing the price of the corresponding offer in cents (e.g., 1999 cents to specify 19.99€). |
cover_start_date | timestamp | Time at which the contract coverage starts. Formatted as a RFC 3339 timestamp |
cover_end_date | timestamp | Time at which the contract coverage ends. Formatted as a RFC 3339 timestamp |
cover_cancelled_date | timestamp | Time at which the contract coverage is cancelled. Formatted as a RFC 3339 timestamp |
cover_withdrawn_date | timestamp | Time at which the contract coverage is withdrawn. Formatted as a RFC 3339 timestamp |
order_id | string | Unique identifier for the order to which this contract corresponds |
purchased_at | timestamp | Time at which the offer was purchased. Formatted as a RFC 3339 timestamp |
policy_title | string | The corresponding insurance policy title |
policy_id | string | The corresponding insurance policy identifier |
term_length | integer | A positive integer representing the term length of the insurance in months. |
insurer_contract_name | string | The corresponding insurance contract name as defined by the insurer. |
coverage | array of strings | Array of coverage options. List of possible coverage options |
recurring_interval | nullable enum | For subscription-based contracts only, the frequency at which the subscription is billed. One of |
products | array | A list of nested objects containing the information of the product purchased with offer. |
billing | address dictionary | A nested object containing the customer's billing information for this order. |
customer | customer dictionary | A nested object containing the information of the customer |
store_id | string | The unique identifier of the store this contract belongs to. |
subscription_id | nullable string | If this contract is paid via a recurring payment, unique identifier of the Subscription representing this payment. |