Get License Details

This API allows you to get the license details.

Request Type

Request URL

https://campaigns.zoho.com/emailapi/v2/license

Content-Type

application/json

List of Response Body Attributes

Parameters	Data Type	Description
license_details	JSON Object	Contains the details of your license.
total_credits	Integer	Total credits of your plan.
credits_remaining	Integer	Credits remaining in your plan.
expiry_time	Long	Shows the time (in milliseconds) of expiry of your license.
plan	String	Shows the plan name - PREPAID or POSTPAID.
response	JSON Object	Contains the response details of the API.
code	Integer	Success or failure code.
message	String	Success or failure message returned by the API.
errors	JSON Object	Contains the error details of the API such as 'code' and 'message'.
plan_type	String	Indicates the type of plan, which includes prepaid, postpaid, trial, or dormant

Run in Postman View Collection

Sample Response - Success 1

Copied{

   "license_details": {

       "total_credits": 12000,

       "credits_remaining": 9984,

       "plan_type": "PREPAID",

         "plan": "Email API - Standard"

   },

   "response": {

       "code": 200801,

       "message": "Successfully obtained the license details"

   }

}

Sample Response - Success 2

Copied{

   "license_details": {

       "expiry_time": 1711087813000,

       "plan_type": "POSTPAID",

         "plan": "Email API - Pay after use",

       "credits_used": 9984

   },

   "response": {

       "code": 200801,

       "message": "Successfully obtained the license details"

   }

}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 500801,
      "message": "An error occurred in License API"
    }
  ]
}