Customer
Overview
The object below is returned directly or within a successful response from the following API requests:
Retrieve a customer
Customer object
Parameters | Type/Description | ||
---|---|---|---|
AvangateCustomerReference |
Int |
||
|
System-generated 2Checkout customer reference.
null when you create a new customer. The 2Checkout system generates default customer numerical (integer) IDs (AV_CUSTOMERID) automatically for all orders containing products that feature subscriptions.
Aggregate subscriptions under the same Customer account by adding the AV_CUSTOMERID (case sensitive) parameter to Buy links. |
||
ExternalCustomerReference |
String |
||
|
Unique customer alphanumeric (string) identifiers you control. Aggregate subscriptions under the same Customer account by adding the CUSTOMERID (case sensitive) parameter to Buy links. |
||
FirstName |
String |
||
|
Customer's first name. |
||
LastName |
String |
||
|
Customer's last name. |
||
Company |
String |
||
|
Company name. |
||
FiscalCode |
String |
||
|
Can be null for end users. For companies, it needs to be the VAT ID, which 2Checkout validates. 2Checkout throws an error if the VAT ID is invalid/incorrect. When present, you also need to provide the company name.
Can be null for end users. |
||
Address1 |
String |
||
|
Customer's address. |
||
Address2 |
String |
||
|
Customer's address. |
||
City |
String |
||
|
Customer's city. |
||
State |
String |
||
|
Customer's state. For example, "Alabama","Alaska","Arizona". |
||
Zip |
String |
||
|
Zip code. |
||
CountryCode |
String |
||
|
Customer's country code (ISO 3166 two-letter code). |
||
Phone |
String |
||
|
Customer's phone number. |
||
Fax |
String |
||
|
Customer's fax number. |
||
|
String |
||
|
Customer's email. |
||
Enabled |
Boolean |
||
|
true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription. Possible customer statuses:
|
||
Trial |
Boolean |
||
|
true or false, depending on whether the customer account features only trials or also paid subscriptions. |
||
Language |
String |
||
|
ISO 639-1 two-letter code. Example: “en.” |