L'objet Plan représente un contrat d'assurance souscrit par un client. Il contient des informations sur le contrat, telles que l'identifiant unique, la référence de commande, la référence de l'offre, le statut, la date d'achat, le titre, la durée, le prix et la devise. Il contient également des informations sur le client, telles que son adresse e-mail, son prénom, son nom, sa date de naissance, son numéro de téléphone et son adresse postale.

ENDPOINTS

GET /api/v2/store/{store_id}/plans : Récupère la liste des contrats vendus par un store ou souscrit par un client en paramètre optionnel :
- customer_email : Adresse email du client.
GET /api/v2/store/{store_id}/plans/{plan_id} : Récupère les informations d'un contrat en particulier.
POST /api/v2/store/{store_id}/plans (BULK) : Crée plusieurs contrats en une seule requête. Cet endpoint permet de notifier Estaly de la souscription d'un contrat d'assurance. Le contrat est activé seulement lorsque Estaly est notifié.

L'objet Plan

Attributs

id (string) : identifiant unique du contrat d'assurance (numéro de contrat)
order_reference_id (string) : référence de la commande associée au contrat d'assurance
offer_reference_id (string) : référence de l'offre associée au contrat d'assurance
status (string) : statut actuel du contrat d'assurance (par exemple, "active", "cancelled", etc.)
purchase_date (string) : date d'achat du contrat d'assurance
title (string) : titre du contrat d'assurance
term_length (integer) : durée du contrat d'assurance en mois
price (float) : prix du contrat d'assurance
currency_code (string) : code de devise du contrat d'assurance (par exemple, "EUR")
customer (object) : objet contenant les informations sur le client ayant souscrit le contrat d'assurance, avec les attributs suivants :
- email (string) : adresse e-mail du client
- first_name (string) : prénom du client
- last_name (string) : nom de famille du client
- birth_date (string) : date de naissance du client
- phone (string) : numéro de téléphone du client
- address (object) : objet contenant les informations sur l'adresse du client, avec les attributs suivants :
  - city (string) : ville de l'adresse
  - country (string) : pays de l'adresse
  - zip_code (string) : code postal de l'adresse
  - address1 (string) : première ligne de l'adresse
  - address2 (string) : deuxième ligne de l'adresse (optionnel)

Exemple de l'objet Plan

{
  "id": "CO12BIPASOFF",
  "order_reference_id": "51965",
  "offer_reference_id": "98498",
  "status": "active",
  "purchase_date": "12/01/2022",
  "title": "Assurance smartphone Casse et Vol - 1 an",
  "term_length": 12,
  "price": 149.00,
  "currency_code": "EUR",
  "customer": {
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "birth_date": "16/05/1985",
    "phone": "+33611223344",
    "address": {
      "city": "Paris",
      "country": "France",
      "zip_code": "75001",
      "address1": "1 Rue des Champs Elysées",
      "address2": ""
    }
  }
}

Dans cet exemple, le contrat d'assurance souscrit a pour numéro de contrat "CO12BIPASOFF".

Il a été souscrit le 12/01/2022, est toujours actif et coûte 149 € pour une durée de 12 mois.