JSON API » plans » plans/fees/set

Sets a fee for a rate plan feature.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
featureStringFeature to set.Yes
occursStringWhen the fee occurs.Yes
planIntegerID of rate plan.Yes
feeDecimalThe fee amount.Recommended0.00

Responses

CodeDescription
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your 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

VersionChanges
3.13Function added.