JSON API » plans » plans/get

Gets the fields of a rate plan.

Input parameters

Does not require authentication.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	No	None.
auth_password	String	Authentication password.	No	None.
id	Integer	ID of rate plan to get.	No	ID of rate plan authentication user is on.

If no authentication is provided, id must be specified.

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
404	The rate plan does not exist, or you do not have permission to view it.

Data returned

Fields of rate plan.

Example: With required parameters

http://enswitch.example.com/api/json/plans/get/?id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example", ... } }

Change history

Version	Changes
3.14	inconnect, incost, inmessage, outconnect, outcost, and outmessage return fields renamed to inconnect_markup, incost_markup, inmessage_markup, outconnect_markup, outcost_markup, and outmessage_markup.
3.13	Function added.