JSON API » plans » plans/fees/set
Sets a fee for a rate plan feature.
Input parameters
Requires authentication and the commerce role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
feature | String | Feature to set. | Yes | |
occurs | String | When the fee occurs. | Yes | |
plan | Integer | ID of rate plan. | Yes | |
fee | Decimal | The fee amount. | Recommended | 0.00 |
Responses
Code | Description |
---|---|
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
403 | Your rate plan does not allow this. |
Data returned
No data is returned.
Example: With required and recommended parameters
http://enswitch.example.com/api/json/plans/fees/set/?auth_username=user;auth_password=password;plan=123;feature=phone;occurs=signup;fee=9.99{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |