JSON API » plans » plans/products/create

Creates a new rate plan product.

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
plan	Integer	ID of rate plan.	Yes
product	Integer	ID of product.	Yes
create_fee	Decimal	Cost to customer on purchase. Only used if use_markups=0.	No	0.00
create_margin	Decimal	Profit margin to add to product's creation fee after markup. Only used if use_markups=1.	No	0.00
create_markup	Integer	Percentage markup on product's creation fee. Only used if use_markups=1.	No	0
currency	String	Currency costs are in.	No	System currency.
period_fee	Decimal	Cost to customer each period. Only used if use_markups=0. Not used for call time products.	No	0.00
period_margin	Decimal	Profit margin to add to product's per billing period fee after markup. Only used if use_markups=1.	No	0.00
period_markup	Integer	Percentage markup on product's per billing period fee. Only used if use_markups=1.	No	0
use_markups	Integer	1 to use markups and margins, 0 to use create_fee and period_fee.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
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 purchase cost

http://enswitch.example.com/api/json/plans/products/create/?auth_username=user;auth_password=password;product=1;plan=2;create_fee=9.99

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.0	create_margin, create_markup, period_margin, period_markup, and use_markups input parameters added.
3.13	Function added.