The unique ID of a customer that is assigned by Voucherify.
cust_CSnYd37MXmrbS19XCrghjBsv
source_id
The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It is externally defined. It can be a customer ID from a CRM system, database or 3rd-party service.
name
Customer's first and last name.
description
An arbitrary string that you can attach to a customer object.
email
Customer's email address.
phone
Customer's phone number.
birthdate
Customer's birthdate.
birthday
Customer's birthday.
address
Customer's address.
Attributes
Description
Example
city
City
state
State
line_1
First line of address.
line_2
Second line of address.
country
Country.
postal_code
Postal code.
summary
Contains a summary of customer's redemption and order statistics.
Attributes
Description
Example
redemptions
Customer's redemptions statistics.
Attributes
Description
Example
total_redeemed
Total number of redemptions made by the customer.
total_failed
Total number of redemptions that failed.
total_succeeded
Total number of redemptions that succeeded.
total_rolled_back
Total number of redemptions that were rolled back for the customer.
total_rollback_failed
Total number of redemption rollbacks that failed.
total_rollback_succeeded
Total number of redemption rollbacks that succeeded.
gift
Summary of gift card credits.
Attributes
Description
Example
redeemed_amount
Total amount of gift card credits redeemed by customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
amount_to_go
Remaining gift card balance across all gift cards. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
loyalty_card
Summary of loyalty points.
Attributes
Description
Example
redeemed_points
Total number of loyalty points redeemed by the customer.
points_to_go
Sum of remaining available point balance across all loyalty cards.
orders
Customer's order statistics.
Attributes
Description
Example
total_amount
The total amount spent by the customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
total_count
Total number of orders made by the customer.
average_amount
Average amount spent on orders. total_amount ÷ total_count. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
last_order_amount
Amount spent on last order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
last_order_date
Timestamp representing the date and time of the customer's last order in ISO 8601 format.
2022-08-30T11:51:08.029Z
loyalty
Summary of customer's loyalty information.
Attributes
Description
Example
points
Sum of remaining available point balance across all loyalty cards.
referred_customers
Total number of customers referred by the customer.
campaigns
Contains campaigns with details about point balances and how many customers were referred by the customer.
Attributes
Description
Example
campaign_name
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Attributes
Description
Example
points
Remaining point balance in campaign.
loyalty_tier
Customer's loyalty tier within the campaign.
ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x
referred_customers
Number of customers referred by the customer in campaign.
referrals
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Attributes
Description
Example
total
Total number of times this customer received a referral, i.e. was referred by another customer.
campaigns
Contains an array of campaigns that served as the source of a referral for the customer.
Array of:
Attributes
Description
Example
campaign_id
Unique campaign ID, assigned by Voucherify.
camp_rRsfatlwN7unSeUIJDCYedal
referrer_id
Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
cust_sehkNIi8Uq2qQuRqSr7xn4Zi
related_object_id
Related object ID, i.e. r_0b9d4cc4aa164dd073.
related_object_type
Related object type, i.e. redemption.
date
Timestamp representing the date and time when the customer was referred in ISO 8601 format.
2022-08-30T10:19:39.196Z
metadata
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.
system_metadata
Object used to store system metadata information.
Attributes
Description
Example
consents
Stores a list of consent ID's along with the timestamp and decision on accepting or rejecting a marketing permission.
Attributes
Description
Example
consentId
Unique ID of a consent, i.e. cnst_lbgOBhHTuDrB7sjIhFjvIALj.
Attributes
Description
Example
date
Timestamp representing the date and time when a consent was accepted or rejected in ISO 8601 format.
2022-05-10T08:50:10.338Z
value
Accepted: true, Rejected: false
source
Takes on the name of the source of the integration if the customer was created through an integration, i.e. Bigcommerce or Shopify.
created_at
Timestamp representing the date and time when the customer was created in ISO 8601 format.
2022-08-30T06:32:07.380Z
updated_at
Timestamp representing the date and time when the customer was updated in ISO 8601 format.
2022-08-31T06:32:07.380Z
assets
Contains information about the customer's cockpit.
Attributes
Description
Example
cockpit_url
Customer's cockpit URL address.
object
The type of object represented by the JSON. This object stores information about the customer.
Language
URL
Click Try It! to start a request and see the response here!
