Customer
Attributes
| Parameters | Type/Description | |||
| CustomerDetails | Object | |||
| AvangateCustomerReference | Optional (Int) | |||
|
System-generated Avangate customer reference.
null when you create a new customer. The Avangate 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 | Optional (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 | Required (string) | |||
| Customer's first name. | ||||
| LastName | Required (string) | |||
| Customer's last name. | ||||
| Company | Optional (string) | |||
| Company name. | ||||
| FiscalCode | Optional (string) | |||
|
Can be null for end users. For companies, it needs to be the VAT ID, which Avangate validates. Avangate 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 | Required (string) | |||
| Customer's address. | ||||
| Address2 | Optional (string) | |||
| Customer's address. | ||||
| City | Required (string) | |||
| Customer's city. | ||||
| State | Optional (string) | |||
| Customer's state. For example, "Alabama","Alaska","Arizona". | ||||
| Zip | Required (string) | |||
| Zip code. | ||||
| CountryCode | Required (string) | |||
| Customer's country code (ISO 3166 two-letter code). | ||||
| Phone | Optional (string) | |||
| Customer's phone number. | ||||
| Fax | Optional (string) | |||
| Customer's fax number. | ||||
| Required (string) | ||||
| Customer's email. | ||||
| ExistingCards | Optional (Array of objects) | |||
| TransientToken | Optional (Object) | |||
| Populated only with when you retrieve customer information by SSOToken. | ||||
| Token | Optional (string) | |||
| Token for the EXISTING_PAYMENT_DATA flow. Use it to charge customers using cards they used in the past for purchases from your Avangate account. | ||||
| CardType | Optional (string) | |||
| visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb | ||||
| LastDigits | Optional (string) | |||
| Last four digits of the credit card. | ||||
| ExpirationMonth | Optional (string) | |||
| Card expiration month. | ||||
| ExpirationYear | Optional (string) | |||
| Card expiration year. | ||||
| NameOnCard | Optional (string) | |||
| Card holder name. | ||||
| Enabled | Optional (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 | Optional (boolean) | |||
| true or false, depending on whether the customer account features only trials or also paid subscriptions. | ||||
| Language | Optional (string) | |||
| ISO 639-1 two-letter code. Example: “en.” | ||||
| Credit | Optional (object) | |||
| Contains information about the credit limit, remaining credit and credit currency. | ||||
| Limit | Float | |||
| The limit must be 0 or a positive number. | ||||
| Remaining | Float | |||
| The remaining must be a valid number. | ||||
| Currency | String | |||
| Currency code must be one of the transactional currencies set on account. | ||||
