JSON API » plans » plans/products/list

Gets the fields of products in a given rate plan.

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 to get products for.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The rate plan does not exist, or you do not have permission to view it.

Data returned

An array of fields, corresponding to the rows of the plan_products table in the database.

Example: With normal parameters

http://enswitch.example.com/api/json/plans/products/list/?auth_username=user;auth_password=password;plan=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "product":1, "plan":123, ... }, { "product":2, "plan":123, ... } ] }

Change history

Version	Changes
3.13	Function added.