Customer

Customers are stored in a Merchant's customer database.

Properties

Property	Type	Description	Example
id	Number(integer)	Read-only unique identifier.	1234567890
first_name	String	Customer's first name.	"Firstname"
last_name	String	Customer's last name.	"Lastname"
contact_media	Array(of Contact Media objects)	At least one Contact Media of type email is required.	See Contact Media Example
addresses	Array(of Address objects)	The address associated to the Customer. Limit 1 for now.	See Address Example
custom_fields	Array(of Custom Field objects)	The custom fields associated with the Customer.	See Custom Field Example
external_id	String	Unique identifier used to look up customer. This is not generated by PaidYET.	"1234567890"

Example

JSON

{
  "first_name": "Firstname",
  "last_name": "Lastname",
  "contact_media": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "addresses": [
    {
      "address": "1234 Test Street S.",
      "city": "Test City",
      "state": "CA",
      "postal": 50001
    }
  ],
  "custom_fields": [
    {
      "id": 1234567890,
      "key": "shoesize",
      "value": "9"
    }
  ],
  "external_id": "1234567890"
}