plan_list Navigate to XML API

This REST API returns the list of the available plans for the enrollment on the basis of the Zip Code, State and Tribal status of the Zip Code. This api can also be used to check whether service is available for a specific Zip Code.

End Point https://www.vcareapi.com:8080/plan
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String plan_list Required This needs to be passed as plan_list Expected Value : plan_list
enrollment_id String ABX123 Optional The enrollment id is returned in the CheckServiceAvailability call and you are required to pass the same enrollment id for the enrollment you are attempting Alphanumeric
zip_code String 08104 Required This is the Zip Code of the customer Should not allow letters and special characters, only numbers. Should be exactly 5 digits.
enrollment_type String LIFELINE Required This determines if the customer being signed up will be a lifeline customer or a prepaid customer. Expected values : LIFELINE , NON_LIFELINE LIFELINE NONLIFELINE
is_enrollment String Y Optional
is_family_plan String Y Optional If you want get family plan than pass Y. Expected value : Y /N
plan_type String DATA Optional If you want the plan which are providing also than pass DATA in this field and if you want the plan which are providing TALK also than pass TALK. Expected values : DATA , TALK
plan_id String 1240 Optional If you want to get particular plan information then pass the plan id of that plan. Valid plan id.
no_of_lines String 2 Optional For add bill_to_customer
login_log_otp String Optional To check service zip info
plan_period_type String MONTHLY Optional To search by expiration days MONTHLY / YEARLY
agent_password String ********* Optional This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the REST API transaction, else if you have set the permissions to password not required then you don’t need to pass the Agent Password in the REST API.
source String API Required Source of the order/application Expected Value : API , WEBSITE
lifeline_enrollment_category String ACP Optional Lifeline enrollment category defines the category of the lifeline i.e ACP or LIFELINE. If you want the ACP plans than pass ACP. If you do not pass anything than by default it will show you all the plans on that ZIP. Expected values : LIFELINE , ACP , COMBO.
is_byod String Y Optional If there is no value in this tag.it is considered as N Expected value : Y / N
tribal String Y Optional If you want the tribal plan than pass tribal as Y Expected value : Y / N
carrier String TMB Optional If you want the plan by carrier than you can pass the abbreviated form of carrier. Valid abbreviation form of the carrier.
plan_type_id String Optional To get plan details
display_status String Y Optional By default it is set to N. If you want the plan whose display status is set to N than you can pass N in this field. Expected value : Y / N
Sample Request REST
{
    "zip_code": "21229",
    "lifeline_enrollment_category": "ACP",
    "is_family_plan": "",
    "enrollment_type": "LIFELINE",
    "action": "plan_list",
    "agent_id": "ewebsiteapi",
    "source": "WEBSITE",
    "request_name": "plan"
}
List of status code, description and resolution.
Status Code Description How to Resolve?
RESTAPI000 SUCCESS SUCCESS
RESTAPI001 FAIL Multiple errors like Invalid Token, Token already used, Token expire & Invalid Access!!
RESTAPI101 FAIL Module required.
RESTAPI102 FAIL Action required.
RESTAPI103 FAIL Source Not Allowed.
RESTAPI104 FAIL Invalid Agent ID or Password.
RESTAPI105 FAIL Module does not exist.
RESTAPI106 FAIL Action does not exist.
RESTAPI107 FAIL Invalid company.
RESTAPI108 FAIL Invalid method.
RESTAPI109 FAIL Unauthorized Access.
RESTAPI010 FAIL Multiple errors come in an array.
Sample Response
{
    "data": [
        {
            "Plan_service_type": "V",
            "advance_billing_month": 0,
            "advance_purchase_discount": "",
            "advance_repayment_month": "0",
            "advance_repayment_month_allowed": "N",
            "allowed_device_type": null,
            "autopay_details": {
                "autopay_discount_detail": []
            },
            "autopay_discount": "N",
            "carrier": [
                "TMB"
            ],
            "connected_plans": [],
            "data": "8000",
            "data_unlimited": "",
            "display_data": "",
            "display_description": "8 GB Data Total Cost: $0",
            "display_features_description": [
                "Nationwide Coverage on one America's Largest 4G LTE / 5G Networks",
                "Voice Minutes & Unlimited Texts!",
                "Voicemail/Caller ID/3-Way Calling",
                "911 & 411 Directory Access"
            ],
            "display_minute": "",
            "display_name": "Standard",
            "display_price": "$0/month",
            "display_sequence": "",
            "display_status": "Y",
            "display_text": "",
            "familyPlanConfig": null,
            "grace_period_allowed_days": "0",
            "is_byod": "",
            "is_connected_plan": "NO",
            "is_familyplan": "",
            "is_prepaid_postpaid": "prepaid",
            "is_regulatory_fee_applicable": "N",
            "is_tax_included": "Y",
            "is_unlimited_plan": "N",
            "minute_unlimited": "",
            "offer_type": "",
            "plan_code": "57",
            "plan_description": "",
            "plan_discount_details": [],
            "plan_expiry_days": 1,
            "plan_expiry_type": "MONTHLY",
            "plan_id": "5539",
            "plan_name": "Standard TTD",
            "plan_price": "0",
            "plan_state": "MD",
            "prepaid_ach_autopay_discount": "",
            "prepaid_credit_card_autopay_discount": "",
            "regulatory_fee_charge_details": [],
            "service_details": [
                {
                    "service_amt": "30",
                    "service_desc": "  ACP Credit\t",
                    "service_name": "  ACP Credit\t",
                    "service_status": "Y",
                    "service_type": "D",
                    "tier_type": "1"
                }
            ],
            "talk": "8000",
            "text": "8000",
            "text_unlimited": "",
            "total_plan_price": "30"
        },
        {
            "Plan_service_type": "V",
            "advance_billing_month": 0,
            "advance_purchase_discount": "",
            "advance_repayment_month": "12",
            "advance_repayment_month_allowed": "Y",
            "allowed_device_type": null,
            "autopay_details": {
                "autopay_discount_detail": []
            },
            "autopay_discount": "N",
            "carrier": [
                "TMB"
            ],
            "connected_plans": [],
            "data": "20000",
            "data_unlimited": "",
            "display_data": "",
            "display_description": "Unlimited Data Total Cost: $12 Upfront",
            "display_features_description": [
                "Nationwide Coverage on one America's Largest 4G LTE / 5G Networks",
                "Voice Minutes & Unlimited Texts!",
                "Voicemail/Caller ID/3-Way Calling",
                "911 & 411 Directory Access"
            ],
            "display_minute": "",
            "display_name": "Unlimited",
            "display_price": "$1/month",
            "display_sequence": "",
            "display_status": "Y",
            "display_text": "",
            "familyPlanConfig": null,
            "grace_period_allowed_days": "0",
            "is_byod": "",
            "is_connected_plan": "NO",
            "is_familyplan": "",
            "is_prepaid_postpaid": "prepaid",
            "is_regulatory_fee_applicable": "N",
            "is_tax_included": "Y",
            "is_unlimited_plan": "",
            "minute_unlimited": "",
            "offer_type": "",
            "plan_code": "49",
            "plan_description": "",
            "plan_discount_details": [],
            "plan_expiry_days": 1,
            "plan_expiry_type": "MONTHLY",
            "plan_id": "4839",
            "plan_name": "Unlimited TTD",
            "plan_price": "1",
            "plan_state": "MD",
            "prepaid_ach_autopay_discount": "",
            "prepaid_credit_card_autopay_discount": "",
            "regulatory_fee_charge_details": [],
            "service_details": [
                {
                    "service_amt": "30",
                    "service_desc": "  ACP Credit\t",
                    "service_name": "  ACP Credit\t",
                    "service_status": "Y",
                    "service_type": "D",
                    "tier_type": "1"
                }
            ],
            "talk": "20000",
            "text": "20000",
            "text_unlimited": "",
            "total_plan_price": "31"
        },
        {
            "Plan_service_type": "V",
            "advance_billing_month": 0,
            "advance_purchase_discount": "",
            "advance_repayment_month": "12",
            "advance_repayment_month_allowed": "Y",
            "allowed_device_type": null,
            "autopay_details": {
                "autopay_discount_detail": []
            },
            "autopay_discount": "N",
            "carrier": [
                "TMB"
            ],
            "connected_plans": [],
            "data": "20000",
            "data_unlimited": "",
            "display_data": "",
            "display_description": "Unlimited Data Total Cost: $20 Upfront",
            "display_features_description": [
                "Nationwide Coverage on one America's Largest 4G LTE / 5G Networks",
                "Voice Minutes & Unlimited Texts!",
                "Voicemail/Caller ID/3-Way Calling",
                "911 & 411 Directory Access",
                "Hotspot & UHD Streaming"
            ],
            "display_minute": "",
            "display_name": "Unlimited Plus",
            "display_price": "$1/month + $8 One-Time",
            "display_sequence": "",
            "display_status": "Y",
            "display_text": "",
            "familyPlanConfig": null,
            "grace_period_allowed_days": "0",
            "is_byod": "",
            "is_connected_plan": "NO",
            "is_familyplan": "N",
            "is_prepaid_postpaid": "prepaid",
            "is_regulatory_fee_applicable": "",
            "is_tax_included": "Y",
            "is_unlimited_plan": "",
            "minute_unlimited": "",
            "offer_type": "",
            "plan_code": "43",
            "plan_description": "",
            "plan_discount_details": [],
            "plan_expiry_days": 1,
            "plan_expiry_type": "MONTHLY",
            "plan_id": "4335",
            "plan_name": "Unlimited+ TTD",
            "plan_price": "1",
            "plan_state": "MD",
            "prepaid_ach_autopay_discount": "",
            "prepaid_credit_card_autopay_discount": "",
            "regulatory_fee_charge_details": [],
            "service_details": [
                {
                    "service_amt": "30",
                    "service_desc": "  ACP Credit\t",
                    "service_name": "  ACP Credit\t",
                    "service_status": "Y",
                    "service_type": "D",
                    "tier_type": "1"
                }
            ],
            "talk": "20000",
            "text": "20000",
            "text_unlimited": "",
            "total_plan_price": "31"
        }
    ],
    "msg": "Success",
    "msg_code": "RESTAPI000",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGVtby1Qcm9zcGVyV2lyZWxlc3NVc2VyIiwicGFzc3dvcmQiOiJEZW1vLVByb3NwZXJXbnIyc2Z3Mmp6eTZwIiwicGluIjoiRGVtby02NDY5MzA5MTM3NDMiLCJ2ZW5kb3JfaWQiOiJEZW1vLVByb3NwZXJXaXJlbGVzcyIsImxvZ19pZCI6MTI1MDg5NiwidXJsIjoiaHR0cHM6Ly9kZW1vLXByb3NwZXIudGVsZ29vNS5jb20vdmNhcmVPc3NBcGkvIn0sImV4cCI6MTcwNDgzODE0NX0.uVS_hZZBX1qR8qvvlVLqaIpE_94QykimRStNOMd85Cw"
}
SUCCESS
Sample Fail Response: 1
{
    
    "msg": "Invalid Token",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Token
How to Resolve?: Provide valid token in header
Sample Fail Response: 2
{
    
    "msg": "Invalid Access!!",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Access!!
How to Resolve?: Request method will be POST
Sample Fail Response: 3
{
    "errors":["Source Not Allowed"]
    "msg": "Source Not Allowed",
    "msg_code": "RESTAPI103",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Source Not Allowed
How to Resolve?: Provide valid Source
Sample Fail Response: 4
{
    "errors":["Agent Id should not be blank"]
    "msg": "Agent Id should not be blank",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Agent Id should not be blank
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 5
{
    "errors":["Invalid Agent Id"]
    "msg": "Invalid Agent Id",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Agent Id
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 6
{
    
    "msg": "Token already used",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token already used
How to Resolve?: You can use token once per request
Sample Fail Response: 7
{
    
    "msg": "Token expire",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token expire
How to Resolve?: Create token again
Sample Fail Response: 8
{
    "errors":["Please enter Enrollment Id"]
    "msg": "Error occurred",
    "msg_code": "RESTAPI110",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Error occurred
How to Resolve?: Provide Enrollment Id

All the status codes are listed under the status code sections. Please click here to go to the status code.