Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
30 lines (23 loc) · 2.09 KB

Customer.md

File metadata and controls

30 lines (23 loc) · 2.09 KB

Customer

Description

Represents one of a business's customers, which can have one or more cards on file associated with it.

Properties

Name Type Description Notes
id String The customer's unique ID.
createdAt String The time when the customer was created, in RFC 3339 format.
updatedAt String The time when the customer was last updated, in RFC 3339 format.
cards List<Card> The payment details of the customer's cards on file. [optional]
givenName String The customer's given (i.e., first) name. [optional]
familyName String The customer's family (i.e., last) name. [optional]
nickname String The customer's nickname. [optional]
companyName String The name of the customer's company. [optional]
emailAddress String The customer's email address. [optional]
address Address The customer's physical address. [optional]
phoneNumber String The customer's phone number. [optional]
birthday String The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. [optional]
referenceId String A second ID you can set to associate the customer with an entity in another system. [optional]
note String A note to associate with the customer. [optional]
preferences CustomerPreferences The customer's preferences. [optional]
groups List<CustomerGroupInfo> The groups the customer belongs to. [optional]
creationSource String A creation source represents the method used to create the customer profile. See CustomerCreationSource for possible values [optional]