Retirement Payload | Climes API

---

This event gets fired when the users' Climes are retired.

Schema

Below is the schema in which the events data will be sent.

Name	Description	Type
partner_order_id	This is the partner_order_id sent while creating the order.	string
customer_name	The name of the user sent while creating the order.	string
customer_email	The users email sent while creating the order.	string
customer_phone	The user phone number sent while creating the order.	string
climes	The total climes allocated to the project.	string
project_id	This is the project_id of the chosen project by the user. You can get the details regarding that project using Get Projects API	string
project_name	This is the name of the project.	string
project_url	This is the URL at which its available in Climes's Website.	string
project_developer	This is the name of the project developer of the project	string
order_date	This is the date at which the order was created.	UTC string
allocation_date	This is the date at which the user allocated their Climes to a certain project.	string
retirement_certificate	This is the retirement certificate stating that the Climes are now retired.	string

Example Payload

{
  "event_type" : "RETIREMENT",
  "payload" : {
    "partner_order_id" : "876287372837786837",
    "customer_name" :"John Doe",
    "customer_email" : "johndoe5675533@gmail.com",
    "customer_phone" : "+916355129211",
    "climes" : 557,
    "project_id" : "farmers-for-forests",
    "project_name" : "Making biodiverse forests financially viable for farmers",
    "project_url" : "https://climes.io/app/projects/farmers-for-forests",
    "project_developer" : "Farmers for Forests",
    "order_date" : "2023-06-21T02:29:50.251Z",
    "allocation_date" : "2023-06-22T06:35:22.314Z",
    "retirement_certificate" : "link-to-retirement-certificate"
  }
}