Referral object

{
  "id": 133577,
  "receiver_customer": {
    "id": 304169229,
    "first_name": "Carmen",
    "last_name": "Sandiego",
    "email": "carmen@smile.io",
    "state": "member",
    "date_of_birth": "1004-05-15",
    "points_balance": 0,
    "referral_url": "http://i.refs.cc/j2Fw66",
    "vip_tier_id": 123,
    "created_at": "2025-04-05T12:11:22.040Z",
    "updated_at": "2025-04-05T12:11:22.040Z"
  },
  "receiver_customer_email": "carmen@smile.io",
  "receiver_reward_fulfillment": {
    "id": 1,
    "name": "Free shipping coupon",
    "code": "freeship-e26d02e39149",
    "image_url": "https://platform-images.smilecdn.co/9283449.png",
    "action_text": "",
    "action_url": "",
    "usage_instructions": "Use this discount code on your next order for free shipping!",
    "terms_and_conditions": "Reward expires on October 4, 2025. Reward can only be used when shipping costs are less than or equal to $20.",
    "expires_at": "2025-10-04T23:59:59.999Z",
    "used_at": "2023-11-07T05:31:56Z",
    "created_at": "2025-04-04T20:15:27.893Z",
    "updated_at": "2025-04-04T20:15:27.893Z"
  },
  "sender_customer": {
    "id": 304169228,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@smile.io",
    "state": "member",
    "date_of_birth": "1004-05-27",
    "points_balance": 300,
    "referral_url": "http://i.refs.cc/9qr5Pw",
    "vip_tier_id": 123,
    "created_at": "2024-04-04T15:10:42.030Z",
    "updated_at": "2024-04-04T15:10:42.030Z"
  },
  "sender_reward_fulfillment": {
    "id": 133578,
    "name": "$25 off coupon",
    "code": "25off-e26d02e39149",
    "image_url": "https://platform-images.smilecdn.co/9283449.png",
    "action_text": "",
    "action_url": "",
    "usage_instructions": "Use this discount code on your next order!",
    "terms_and_conditions": "Reward expires on October 5, 2025. Reward can only be used on purchases of $50 or more.",
    "expires_at": "2025-10-05T23:59:59.999Z",
    "used_at": "2023-11-07T05:31:56Z",
    "created_at": "2025-04-05T12:15:22.040Z",
    "updated_at": "2025-04-05T12:15:22.040Z"
  },
  "created_at": "2025-04-04T20:15:27.893Z",
  "updated_at": "2025-04-05T12:15:22.040Z"
}

A referral is a record of a customer encouraging someone else to shop with the merchant, where both the customer and the other individual are rewarded for their actions.

integer

Unique identifier for the referral.

Example:

133577

receiver_customer

object

A nested Customer object representing the individual who is being referred. Only present after an order is placed using the referral coupon.

Show child attributes

receiver_customer_email

string

The email address of the individual being referred.

Example:

"carmen@smile.io"

receiver_reward_fulfillment

object

A nested Reward Fulfillment object representing the reward that was issued to the individual who is being referred.

Show child attributes

sender_customer

object

A nested Customer object representing the customer whose referral link was used to initiate the referral.

Show child attributes

sender_reward_fulfillment

object

A nested Reward Fulfillment object representing the reward issued to the customer whose referral link was used to initiate the referral. Only present after the individual being referred places an order.

Show child attributes

created_at

string<date-time>

The date and time when the referral was created.

Example:

"2025-04-04T20:15:27.893Z"

updated_at

string<date-time>

The date and time when the referral was last updated.

Example:

"2025-04-05T12:15:22.040Z"

Retrieve a points transaction

Reward object

⌘I

REST API

API resources