Customer Object

Customer With Summary Loyalty Referrals

All of:

Customer Response Data

Attributes Description

id
string

The ID of an existing customer that will be linked to redemption in this request.

source_id
string

A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.

summary Customer Summary

loyalty Customer Loyalty

referrals Customer Referrals

system_metadata
object

Object used to store system metadata information.

created_at
string

Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format.

Example:

2022-08-30T06:32:07.380Z

updated_at
string

Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format.

Example:

2022-08-31T06:32:07.380Z

assets
object

Contains information about the customer's cockpit.

Attributes	Description
cockpit_url `string`	Customer's cockpit URL address.

object
string

The type of the object represented by JSON.

Available values: customer

Customer Base

Customer Summary

Attributes	Description
redemptions	See: Customer Summary Redemptions
orders	See: Customer Summary Orders

Customer Loyalty

Attributes Description

points
integer

Customer's loyalty points minus expired for all loyalty cards which the customer has.

referred_customers
integer

Total number of customers referred by the customer.

campaigns
object

Contains campaigns with details about point balances and how many customers were referred by the customer.

Attributes Description

[propertyName]
object

Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.

Attributes Description

points
integer

Remaining point balance in campaign.

loyalty_tier
string

Customer's loyalty tier within the campaign.

Example:

ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x

referred_customers
integer

Number of customers referred by the customer in campaign.

Customer Referrals

Attributes Description

total
integer

Total number of times this customer received a referral, i.e. was referred by another customer.

campaigns
array

Contains an array of campaigns that served as the source of a referral for the customer.

Array of:

Customer Referrals Campaigns Item

Attributes	Description
campaign_id `string`	Unique campaign ID, assigned by Voucherify. Example: camp_rRsfatlwN7unSeUIJDCYedal
referrer_id `string`	Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer. Example: cust_sehkNIi8Uq2qQuRqSr7xn4Zi
related_object_id `string`	Related object id Example: r_0b9d4cc4aa164dd073
related_object_type `string`	Related object type, i.e. `redemption`.
date `string`	Timestamp representing the date and time when the customer was referred in ISO 8601 format. Example: 2022-08-30T10:19:39.196Z

Customer Base

Attributes Description

name
string

Customer's first and last name.

description
string

An arbitrary string that you can attach to a customer object.

email
string

Customer's email address.

phone
string

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

birthday
string

Deprecated. ~~Customer's birthdate; format YYYY-MM-DD~~.

birthdate
string

Customer's birthdate; format YYYY-MM-DD.

address
object, null

Customer's address.

Attributes	Description
city `string`	City
state `string`	State
line_1 `string`	First line of address.
line_2 `string`	Second line of address.
country `string`	Country.
postal_code `string`	Postal code.

metadata
object

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.

Customer Summary Redemptions

Attributes Description

total_redeemed
integer

Total number of redemptions made by the customer.

total_failed
integer

Total number of redemptions that failed.

total_succeeded
integer

Total number of redemptions that succeeded.

total_rolled_back
integer

Total number of redemptions that were rolled back for the customer.

total_rollback_failed
integer

Total number of redemption rollbacks that failed.

total_rollback_succeeded
integer

Total number of redemption rollbacks that succeeded.

gift
object

Summary of gift card credits.

Attributes	Description
redeemed_amount `integer`	Total amount of gift card credits redeemed by customer. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
amount_to_go `integer`	Remaining gift card balance across all gift cards. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.

loyalty_card
object

Summary of loyalty points.

Attributes	Description
redeemed_points `integer`	Total number of loyalty points redeemed by the customer.
points_to_go `integer`	Sum of remaining available point balance across all loyalty cards.

Customer Summary Orders

Attributes	Description
total_amount `integer`	The total amount spent by the customer. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
total_count `integer`	Total number of orders made by the customer.
average_amount `integer`	Average amount spent on orders. `total_amount` ÷ `total_count`. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
last_order_amount `integer`	Amount spent on last order. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
last_order_date `string`	Timestamp representing the date and time of the customer's last order in ISO 8601 format. Example: 2022-08-30T11:51:08.029Z