WhiteLabel API
Clients

Client Object

Attributes

id string A unique identifier for the client.



object string The value is always client.



name string The name of the client.



email string The email of the client.



country string (Country code) The billing country of the client.



registration_date timestamp The date the client was created.



telephone string The client's phone number.



status string The possible values are pending, trialing, active and inactive.



permissions object Permissions Reference An object containing the permissions of the client.



billing_plan object A Subscription Object containing the billing configuration of the client's subscription plan.



business_information object An object containing the shop settings of the client.

JSON

  • name string The shop's business name.
  • country string (Country code) The shop's country.
  • email email The email of the shop.
  • default_currency string currency code The default currency of the shop.
  • offset string The timezone offset of the shop.
  • facebook string The Facebook link of the shop.
  • twitter string The Twitter profile of the shop.
  • instagram string The Instagram profile of the shop.
  • pinterest string The Pinterest profile of the shop.
  • currencies array of strings Currency codes The currencies configured on the client account.
  • languages array of strings (Language codes) The languages configured on the client account.
  • address string The billing address of the client.
  • postcode string The shop's postcode.
  • state string The shop's state (if applicable).
  • vat string The VAT number of the client's shop.
  • city string The shop's city.
  • telephone string The shop's telephone.
  • currency_conversion boolean This attribute shows whether currency conversion features are activated on the client's shop.


quotas object An object containing the quotas of the client.

Example