Browse Plan API

Browse Plan API

Method: POST
Headers:
    Content-Type: application/json
    API-Key: (api key shared with the partner)

Request

Request Body Parameter	Data Type	Mandatory?	Size
mobileNumber	String	Yes	Min = 10, Max = 10
operatorCode	String	No	Max = 5
circleCode	String	No	Max = 5

Sample Request

{
  "mobileNumber": "9999999999",
  "operatorCode": "1",
  "circleCode": "10"
}
operatorCode: 1: Airtel
circleCode: 10: Karnataka
Added a complete list at the end of the document.

Sample Response

Success Status Code: 200

{
  "operatorCode": "1",
  "circleCode": "10",
  "planTypes": {
    "planType": "Unlimited",
    "plans": [
      {
        "id": 12344,
        "title": "1.5 GB / Day Combo 3G Data Pack",
        "remarks": "Enjoy TRULY unlimited Local, STD & Roaming calls on any network, 1.5 GB data per day, 100 National SMS/day for 84 days|Xstream Mobile Pack,(SonyLiv,LionsgatePlay,ErosNow,HoiChoi,ManoramaMAX,Chaupal)",
        "validityString": "84 days",
        "talkTime": 25.25,
        "data": 50000,
        "amount": 719,
        "dataString": "1.5 GB/ Day",
        "oldPlanAmount": 5,
        "smsString": "100 SMS / Day",
        "tag": "Best 5G Plan",
        "calls": "Unlimited",
        "additionalBenefits": [
          {
            "id": 98,
            "image": "https://c.kmpr.in/benefit_images/98.png",
            "name": "Complimentary subscription to Jio Apps",
            "extra_info": "JioTV, JioCloud"
          },
          {
            "id": 99,
            "image": "https://c.kmpr.in/benefit_images/99.png",
            "name": "JioSaavn Pro",
            "extra_info": "To activate JioSaavn Pro subscription login to JioSaavn app."
          }
        ]
      }
    ]
  }
}

Response Body Parameter	Data Type	Size
planType	String	Min = 5, Max = 20
operatorCode	String	Max = 5
circleCode	String	Max = 5
id	Integer	Max = 100000000
title	String	Max = 1500
remarks	String	Max = 1500
validityString	String	Max = 1500
talkTime	Double	-
data	Double	-
amount	Double	-
dataString	String	-
oldPlanAmount	Double	-
smsString	String	-
tag	String	-
calls	String	-
AdditionalData - id, image, name, extra_info	id - Integer, image - String (url), name - String, extra_info - String

Sample Error Response

Status Code: 400

{
  "errorCode": 803,
  "errorMessage": "invalid mobile number provided"
}

Error handling and error responses are common for all APIs provided in a separate section

Details

1. The operator code/circle code is optional for this API, in case it is not provided or not found, the API will internally look for the correct operator and circle for the given mobile number and will give plans accordingly.

2. Here the planType field signifies the category to which the plan belongs. Please note that the same plans can be present in multiple planTypes as one plan can fit into different categories