Customer

The Customer object

idId (string)

Unique identifier for the object.

tenantTenantMode (string)

Has the value "live" if the object exists in live mode, or "sand" if it exists in test mode.

Possible values: [sand, live]

emailstring

The customer’s email address.

firstNamestringnullable

The customer’s first name.

lastNamestringnullable

The customer’s last name.

phoneNumberstringnullable

The customer’s phone number.

referenceIdstringnullable

A unique identifier from your system that you can use to reference this Customer. This can be used to reconcile the Customer with your internal systems.

companyIdstringnullable

The ID of the Company this Customer is associated with.

wallet object

Summary information about the Customer's wallet, including total amounts and last update timestamp.

totalAmountinteger<int64>

The total amount available in the customer's wallet, in cents.

totalVoucherAmountinteger<int64>

The total amount of voucher funds available in the customer's wallet, in cents.

lastUpdatedOnUtcstring<date-time>

The UTC timestamp of when the wallet totals were last updated.

metadata objectnullable

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. It can contain up to 10 key-value items with a maximum length of 40 for the key and of 400 chars for the value.

property name*string

property name*any

The Customer object

Customer

{
  "id": "string",
  "tenant": "sand",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "referenceId": "string",
  "companyId": "string",
  "wallet": {
    "totalAmount": 0,
    "totalVoucherAmount": 0,
    "lastUpdatedOnUtc": "2024-07-29T15:51:28.071Z"
  },
  "metadata": {}
}