> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer Object

<div class="prose dark:prose-invert custom-html">
  <h2 id="customer-with-summary-loyalty-referrals">Customer With Summary Loyalty Referrals</h2>
  <p>All of:</p>

  <ol>
    <li>
      <h3>Customer Response Data</h3>

      <table>
        <thead>
          <tr>
            <th>Attributes</th>
            <th>Description</th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>
              <p>
                id

                <br />

                <code>string</code>
              </p>
            </td>

            <td>
              <p>The ID of an existing customer that will be linked to redemption in this request.</p>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                source\_id

                <br />

                <code>string</code>
              </p>
            </td>

            <td>
              <p>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.</p>
            </td>
          </tr>

          <tr>
            <td>
              <p>summary</p>
            </td>

            <td>
              <a href="#customer-summary">Customer Summary</a>
            </td>
          </tr>

          <tr>
            <td>
              <p>loyalty</p>
            </td>

            <td>
              <a href="#customer-loyalty">Customer Loyalty</a>
            </td>
          </tr>

          <tr>
            <td>
              <p>referrals</p>
            </td>

            <td>
              <a href="#customer-referrals">Customer Referrals</a>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                system\_metadata

                <br />

                <code>object</code>
              </p>
            </td>

            <td>
              <p>Object used to store system metadata information.</p>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                created\_at

                <br />

                <code>string</code>
              </p>
            </td>

            <td>
              <p>Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format.</p>

              <p>
                <strong>Example:</strong>
                2022-08-30T06:32:07.380Z
              </p>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                updated\_at

                <br />

                <code>string</code>
              </p>
            </td>

            <td>
              <p>Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format.</p>

              <p>
                <strong>Example:</strong>
                2022-08-31T06:32:07.380Z
              </p>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                assets

                <br />

                <code>object</code>
              </p>
            </td>

            <td>
              <p>Contains information about the customer's cockpit.</p>
              <p>⚠️ Warning: Customer cockpits were removed. The customer cockpit URLs redirect to customer preference center.</p>

              <table>
                <thead>
                  <tr>
                    <th>Attributes</th>
                    <th>Description</th>
                  </tr>
                </thead>

                <tbody>
                  <tr>
                    <td>
                      <p>
                        cockpit\_url

                        <br />

                        <code>string</code>
                      </p>
                    </td>

                    <td>
                      <p>URL address to customer preference center. Previously, a customer's cockpit URL address.</p>
                    </td>
                  </tr>

                  <tr>
                    <td>
                      <p>
                        cockpit\_preference\_center\_url

                        <br />

                        <code>string</code>
                      </p>
                    </td>

                    <td>
                      <p>URL address to customer preference center.</p>
                    </td>
                  </tr>
                </tbody>
              </table>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                object

                <br />

                <code>string</code>
              </p>
            </td>

            <td>
              <p>The type of the object represented by JSON.</p>

              <p>
                Available values:
                <code>customer</code>
              </p>
            </td>
          </tr>
        </tbody>
      </table>
    </li>

    <li>
      <a href="#customer-base">Customer Base</a>
    </li>
  </ol>

  <h2 id="customer-summary">Customer Summary</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>redemptions</p>
        </td>

        <td>
          See:
          <a href="#customer-summary-redemptions">Customer Summary Redemptions</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>orders</p>
        </td>

        <td>
          See:
          <a href="#customer-summary-orders">Customer Summary Orders</a>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="customer-loyalty">Customer Loyalty</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            points

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Customer's loyalty points minus expired for all loyalty cards which the customer has.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            referred\_customers

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of customers referred by the customer.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            campaigns

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>Contains campaigns with details about point balances and how many customers were referred by the customer.</p>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    \[propertyName]

                    <br />

                    <code>object</code>
                  </p>
                </td>

                <td>
                  <p>Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.</p>

                  <table>
                    <thead>
                      <tr>
                        <th>Attributes</th>
                        <th>Description</th>
                      </tr>
                    </thead>

                    <tbody>
                      <tr>
                        <td>
                          <p>
                            points

                            <br />

                            <code>integer</code>
                          </p>
                        </td>

                        <td>
                          <p>Remaining point balance in campaign.</p>
                        </td>
                      </tr>

                      <tr>
                        <td>
                          <p>
                            loyalty\_tier

                            <br />

                            <code>string</code>
                          </p>
                        </td>

                        <td>
                          <p>Customer's loyalty tier within the campaign.</p>

                          <p>
                            <strong>Example:</strong>
                            ltr\_UJ5Q54Q0OvEhua87Qfv2Ki5x
                          </p>
                        </td>
                      </tr>

                      <tr>
                        <td>
                          <p>
                            referred\_customers

                            <br />

                            <code>integer</code>
                          </p>
                        </td>

                        <td>
                          <p>Number of customers referred by the customer in campaign.</p>
                        </td>
                      </tr>
                    </tbody>
                  </table>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="customer-referrals">Customer Referrals</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            total

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of times this customer received a referral, i.e. was referred by another customer.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            campaigns

            <br />

            <code>array</code>
          </p>
        </td>

        <td>
          <p>Contains an array of campaigns that served as the source of a referral for the customer.</p>
          Array of:
          <h3>Customer Referrals Campaigns Item</h3>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    campaign\_id

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Unique campaign ID, assigned by Voucherify.</p>

                  <p>
                    <strong>Example:</strong>
                    camp\_rRsfatlwN7unSeUIJDCYedal
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    referrer\_id

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer.</p>

                  <p>
                    <strong>Example:</strong>
                    cust\_sehkNIi8Uq2qQuRqSr7xn4Zi
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    related\_object\_id

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Related object id</p>

                  <p>
                    <strong>Example:</strong>
                    r\_0b9d4cc4aa164dd073
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    related\_object\_type

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>
                    Related object type, i.e.
                    <code>redemption</code>.
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    date

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Timestamp representing the date and time when the customer was referred in ISO 8601 format.</p>

                  <p>
                    <strong>Example:</strong>
                    2022-08-30T10:19:39.196Z
                  </p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="customer-base">Customer Base</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            name

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Customer's first and last name.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            description

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>An arbitrary string that you can attach to a customer object.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            email

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Customer's email address.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            phone

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            birthday

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            <code>Deprecated</code>.
            <s>Customer's birthdate; format YYYY-MM-DD</s>.
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            birthdate

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Customer's birthdate; format YYYY-MM-DD.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            address

            <br />

            <code>object</code>,
            <code>null</code>
          </p>
        </td>

        <td>
          <p>Customer's address.</p>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    city

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>City</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    state

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>State</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    line\_1

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>First line of address.</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    line\_2

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Second line of address.</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    country

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Country.</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    postal\_code

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Postal code.</p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            metadata

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>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.</p>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="customer-summary-redemptions">Customer Summary Redemptions</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            total\_redeemed

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of redemptions made by the customer.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            total\_failed

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of redemptions that failed.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            total\_succeeded

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of redemptions that succeeded.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            total\_rolled\_back

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of redemptions that were rolled back for the customer.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            total\_rollback\_failed

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of redemption rollbacks that failed.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            total\_rollback\_succeeded

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of redemption rollbacks that succeeded.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            gift

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>Summary of gift card credits.</p>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    redeemed\_amount

                    <br />

                    <code>integer</code>
                  </p>
                </td>

                <td>
                  <p>
                    Total amount of gift card credits redeemed by customer. The value is multiplied by 100 to represent 2 decimal places. For example
                    <code>10000 cents</code>
                    for
                    <code>\$100.00</code>.
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    amount\_to\_go

                    <br />

                    <code>integer</code>
                  </p>
                </td>

                <td>
                  <p>
                    Remaining gift card balance across all gift cards. The value is multiplied by 100 to represent 2 decimal places. For example
                    <code>10000 cents</code>
                    for
                    <code>\$100.00</code>.
                  </p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            loyalty\_card

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>Summary of loyalty points.</p>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    redeemed\_points

                    <br />

                    <code>integer</code>
                  </p>
                </td>

                <td>
                  <p>Total number of loyalty points redeemed by the customer.</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    points\_to\_go

                    <br />

                    <code>integer</code>
                  </p>
                </td>

                <td>
                  <p>Sum of remaining available point balance across all loyalty cards.</p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="customer-summary-orders">Customer Summary Orders</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            total\_amount

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>
            The total amount spent by the customer. The value is multiplied by 100 to represent 2 decimal places. For example
            <code>10000 cents</code>
            for
            <code>\$100.00</code>.
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            total\_count

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>Total number of orders made by the customer.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            average\_amount

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>
            Average amount spent on orders.
            <code>total\_amount</code>
            ÷
            <code>total\_count</code>.
            The value is multiplied by 100 to represent 2 decimal places. For example
            <code>10000 cents</code>
            for
            <code>\$100.00</code>.
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            last\_order\_amount

            <br />

            <code>integer</code>
          </p>
        </td>

        <td>
          <p>
            Amount spent on last order. The value is multiplied by 100 to represent 2 decimal places. For example
            <code>10000 cents</code>
            for
            <code>\$100.00</code>.
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            last\_order\_date

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time of the customer's last order in ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2022-08-30T11:51:08.029Z
          </p>
        </td>
      </tr>
    </tbody>
  </table>
</div>