JSON API » charges » charges/list

Gets the fields of all charges for the given customer or 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
customer	Integer	ID of customer.	Yes, unless plan is specified.	Customer of authentication user.
plan	Integer	ID of plan.	Yes, unless customer is specified.	0

Specify either customer or plan, but not both.

Responses

Code	Description
200	Success.
400	Invalid customer or plan specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

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

Example: With required parameters

http://enswitch.example.com/api/json/charges/list/?auth_username=user;auth_password=password;customer=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

Version	Changes
3.13	Function added.