Customers

A customer represents an entity (business or individual) and the associated payment methods (Credit Card or Bank Account), which can then be used for payment methods such as direct debits and payment plans.

Response object

Field	Type	Description
id	String	Unique ID for the customer
email	String	The customer’s email address (used to deliver email receipts if requested).
reference	String	A reference for the customer record (e.g. your database ID).
first_name	String	The customer’s first name.
last_name	String	The customer’s last name.
created_at	Date as String (ISO 8601)	The date that the customer was created.
address	hash	| Hash | | | | ---------- | ------ | ------------------------ | | address | string | The customer’s address. | | city | string | The customer’s city. | | state | string | The customer’s state. | | postcode | string | The customer’s postcode. | | country | string | The customer’s country. |
card_token	string	The customer’s card token.
card_number	string	The customer’s card number.
bank_account	string	The customer's bank account BSB and account number. e.g. "012-345 012345678"
metadata	hash	Hash of key/value pairs attached to the customer during creation only.