Customers can be added, updated, or inactivated via the API.Customers may be in either an "Active", "Suspended" or "Inactive"state. Suspended customers still accumulate charges on theircurrent balance even though their credit card is not charged untilthey are in the active state again. Inactive customers are nolonger charged.
Methods
The following methods are available:
- GetCustomers
- GetCustomer
- CreateCustomer
- UpdateCustomer
- UpdateCustomer Status
- Get Customer Balance
- Authenticate Customer
- Reset Customer Password
- Customer Email Exists
Data Structures
Customer
| Field | Description | Required | Format |
|---|---|---|---|
| AddressLine1 | Street address line 1 for customer address. | up to 60 characters | |
| AddressLine2 | Street address line 2 for customer address. | up to 60 characters | |
| City | City for customer address. | up to 60 characters | |
| Company | Company for customer. | up to 60 characters | |
| CountryCode | Three letter ISO country code for customer address. | yes | 3 characters |
| CustomerID | Numeric customer ID. | yes | numeric |
| EmailAddress | Customer e-mail address. Also login username. | yes | up to 200 characters |
| FaxNumber | Fax number for customer. | up to 40 characters | |
| FirstName | First name for customer. | yes | up to 60 characters |
| HomeNumber | Home telephone number for customer. | up to 40 characters | |
| LastName | Last name for customer. | yes | up to 60 characters |
| MiddleName | Middle name for customer. | up to 60 characters | |
| MobileNumber | Mobile telephone number for customer. | up to 40 characters | |
| NamePrefix | Name prefix for customer name. | up to 20 characters | |
| NameSuffix | Name suffix for customer name. | up to 20 characters | |
| Password | Password for customer login. | up to 200 characters | |
| PostalCode | Postal code for customer address. | up to 60 characters | |
| StateProvince | State or province for customer address. | up to 60 characters | |
| Title | Title for customer. | up to 60 characters | |
| WebPageURL | Web page URL for customer. | up to 200 characters | |
| WorkNumber | Work telephone number for customer. | up to 40 characters |