The contract V2 object

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.

{
  "amount_paid": 1201,
  "cover_cancelled_date": null,
  "coverage": [
    "extended_warranty"
  ],
  "created_at": "2023-10-13T09:22:20.849469Z",
  "currency": "EUR",
  "customer_contract_id": "EYD7FR6",
  "customer_id": "ea3e37da-592c-4ee5-81d8-48e6fa4e542a",
  "embedded": false,
  "id": "ba6e56c4-58de-495d-bd7b-12f2172c5ab6",
  "insurer_contract_name": "EVYFGFR",
  "market": "FR",
  "object": "contract",
  "offer_designation": "insurance",
  "order_external_id": "a77ff9f5-64cb-49de-b6af-004b84ec6e99",
  "order_id": "7756719b-6d24-432e-b7b5-32bb06e5c739",
  "orders_intent_id": null,
  "payment_handler": "merchant",
  "physical_store": null,
  "policy_id": "ed733cd9-073a-4fed-ac02-9148634705f1",
  "products": [
    {
      "brand": "Ninja",
      "catalog_amount": null,
      "color": "Noir/Argent",
      "condition": "refurbished",
      "currency": "EUR",
      "description": null,
      "id": "d2fdd1ad-b988-44d5-a80a-b95a8ebbced8",
      "imei": null,
      "model": "AF400",
      "operator_category": "SMALL APPLIANCE",
      "operator_category_id": "56",
      "purchase_amount": 123,
      "purchase_date": "2023-10-13",
      "purchased_at": "2023-10-13T09:22:20.647091Z",
      "refurbished_grade": "A",
      "serial_number": null,
      "sku": "AF400EUREF",
      "storage": null,
      "title": "Friteuse Ninja AF400"
    }
  ],
  "purchased_at": "2023-10-13T09:22:20.647091Z",
  "recurring_interval": null,
  "status": "on_hold",
  "store_id": "bd600a06-f979-40b3-a478-32bd8fca7d03",
  "subscription_id": null,
  "term_length_months": 24
}

Attributes

object

string, value is contract

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 cancelled, activated, expired, on_hold, terminated, suspended

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_cancelled_date

date

Date at which the contract coverage was cancelled. Formatted as a ISO 8601 date (ex: "2024-01-12")

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_month

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 "month" or "year". Set to null otherwise.

products

array

A list of nested objects containing the information of the product purchased with offer.

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. If not, this is set to null.

payment_handler

enum, evy or merchant

Specifies which party is in charge of collecting payments for the contract.