JSON API » taxes » taxes/list

Gets the fields of all taxes in the given customer, applicable to that customer, or available for use by that customer.

Input parameters

Requires authentication and the commerce or the payment role privilege, unless signup=1 is specified.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes, unless signup=1.
auth_password	String	Authentication password.	Yes, unless signup=1.
applicable	Integer	1 to get taxes applicable to customer, 0 to get taxes in customer.	No	0
available	Integer	1 to get taxes available for use (including any shared by the system owner), 0 to get taxes in customer.	No	0
customer	Integer	ID of customer to get taxes for.	No	Customer of authentication user.
plan	Integer	ID of signup rate plan. Only used when signup=1.	Yes if signup=1.	0
signup	Integer	1 to get taxes applicable to signup, 0 for normal use.	No	0
type	String	"account" or "feature". Only used when signup=1.	Yes if signup=1.	Empty string.

Responses

Code	Description
200	Success.
400	Invalid customer 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 taxes table in the database.

Example: With normal parameters

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

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

Change history

Version	Changes
3.13	Function added.