JSON API » plans » plans/classes/create

Creates a new rate plan number class.

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
class	Integer	ID of number class.	Yes
plan	Integer	ID of rate plan.	Yes
description	String	Description.	No	Empty string.
fee	Decimal	Amount to charge each billing period.	No	0.00
signup	Decimal	Amount to charge on purchase.	No	0.00
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.
404	The rate plan does not exist, or you do not have permission to view it.

Data returned

The ID of the created rate plan number class.

Example: With required parameters

http://enswitch.example.com/api/json/plans/classes/create/?auth_username=user;auth_password=password;class=1;plan=2

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

Change history

Version	Changes
3.13	Function added.