List customers

listCustomers returns the customers that belong directly to the authenticated customer, sorted by name. Sub-customers of those customers are not included. Use it to find a customer’s i_customer or to show balances in your own system.

The method supports trusted mode with i_wholesaler, the ID of the customer whose customers you list.

Parameters

Name	Type	Required	Description
`limit`	int	no	Return at most this many customers. Default: all
`offset`	int	no	Skip this many customers first. Used only together with `limit`. Default `0`

Returns

Name	Type	Description
`result`	string	`OK`
`customers`	array	One struct per customer, with the fields below

Name	Type	Description
`i_customer`	int	ID of the customer
`name`	string	Reseller Name
`web_login`	string	Web Login of the default web user
`description`	string	Description
`balance`	double	Current balance, in `base_currency`
`credit_limit`	double	Credit Limit, in `base_currency`
`base_currency`	string	Base currency, ISO 4217

Example

call("listCustomers", {"limit": 50, "offset": 0})

{
    "result": "OK",
    "customers": [
        {
            "i_customer": 3,
            "name": "Acme Telecom",
            "web_login": "acme-web",
            "description": "Wholesale, net 30",
            "balance": 150.0,
            "credit_limit": 500.0,
            "base_currency": "USD",
        },
    ],
}