JSON API » incosts » incosts/get

Gets a cost for inbound calls.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of cost to get.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The cost does not exist, or you do not have permission to view it.

Data returned

The fields of the cost.

Example: With required parameters

http://enswitch.example.com/api/json/incosts/get/?auth_username=user;auth_password=password;id=123

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

Change history

VersionChanges
3.13Function added.