Customer
Use the object below to create, update and retrieve customers in 2Checkout.
Request parameters
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 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
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.
Email
Required (string) Customer's email.
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:
Active - Customer account status is Active even if Trial and Cancelled/Expired subscriptions exist for the customer, along as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active.
Inactive - All subscriptions associated to this Customer account are cancelled, expired or both.
Trial - Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Cancelled/Expired subscriptions.
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.
Credit.Limit
Float The limit must be 0 or a positive number.
Credit.Remaining
Float The remaining must be a valid number.
Credit.Currency
String Currency code must be one of the transactional currencies set on account.
Last updated
Was this helpful?