JSON API » plans » plans/fees/get
Gets a fee for a rate plan feature.
Input parameters
Does not require authentication, unless plan is not specified.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | No, unless plan not specified. | |
auth_password | String | Authentication password. | No, unless plan not specified. | |
feature | String | Feature to get fees for. | Yes | |
occurs | String | When the fee occurs. | Yes | |
customer | Integer | ID of customer to create in. | No | Customer of authentication user. |
plan | Integer | ID of rate plan. | No | Rate plan of authentication user. |
currency | String | Currency to return fee in. | No | See below. |
If the currency is not specified, the customer's billing currency is used if authentication is provided, else the system currency.
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
Data returned
Fee amount.
Example: With rate plan
http://enswitch.example.com/api/json/plans/fees/get/?plan=123;feature=phone;occurs=signup{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "fee":"9.99", ... } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |