> ## 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.

# Loyalty Tier Object

<div class="prose dark:prose-invert custom-html">
  <h2 id="loyalty-tier">Loyalty Tier</h2>
  <p>All of:</p>

  <ol>
    <li>
      <a href="#loyalty-tier-base">Loyalty Tier Base</a>
    </li>

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

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

                <br />

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

            <td>
              <p>Unique loyalty tier ID.</p>
            </td>
          </tr>

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

                <br />

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

            <td>
              <p>Unique parent campaign ID.</p>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                metadata

                <br />

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

            <td>
              <p>The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.</p>
            </td>
          </tr>

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

                <br />

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

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

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

                <br />

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

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

          <tr>
            <td>
              <p>
                config

                <br />

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

            <td>
              <p>Defines loyalty tier range in points.</p>

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

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

                        <br />

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

                    <td>
                      <p>Defines range of loyalty tier in points.</p>

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

                        <tbody>
                          <tr>
                            <td>
                              <p>
                                from

                                <br />

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

                            <td>
                              <p>Bottom points threshold value.</p>
                            </td>
                          </tr>

                          <tr>
                            <td>
                              <p>
                                to

                                <br />

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

                            <td>
                              <p>Top points threshold value.</p>
                            </td>
                          </tr>
                        </tbody>
                      </table>
                    </td>
                  </tr>
                </tbody>
              </table>
            </td>
          </tr>

          <tr>
            <td>
              <p>expiration</p>
            </td>

            <td>
              See:
              <a href="#loyalty-tier-expiration">Loyalty Tier Expiration</a>
            </td>
          </tr>

          <tr>
            <td>
              <p>
                object

                <br />

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

            <td>
              <p>The type of the object represented by JSON. This object stores information about the loyalty.</p>

              <p>
                Available values:
                <code>loyalty\_tier</code>
              </p>
            </td>
          </tr>
        </tbody>
      </table>
    </li>
  </ol>

  <h2 id="loyalty-tier-base">Loyalty Tier 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>Loyalty Tier name.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            earning\_rules

            <br />

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

        <td>
          <p>Contains a list of earning rule IDs and their points mapping for the given earning rule.</p>

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

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

                <td>
                  See:
                  <a href="#mappingpoints">MappingPoints</a>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            rewards

            <br />

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

        <td>
          <p>Contains a list of reward IDs and their points mapping for the given reward.</p>

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

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

                <td>
                  See:
                  <a href="#mappingpoints">MappingPoints</a>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            points

            <br />

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

        <td>
          <p>Defines range of loyalty tier in points.</p>

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

            <tbody>
              <tr>
                <td>
                  <p>
                    from

                    <br />

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

                <td>
                  <p>Bottom points threshold value.</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    to

                    <br />

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

                <td>
                  <p>Top points threshold value.</p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="loyalty-tier-expiration">Loyalty Tier Expiration</h2>

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

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

            <br />

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

        <td>
          <p>Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.</p>

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

      <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>
            tier\_id

            <br />

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

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

      <tr>
        <td>
          <p>
            start\_date

            <br />

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

        <td>
          <p>Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            expiration\_date

            <br />

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

        <td>
          <p>Expiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.</p>
        </td>
      </tr>

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

            <br />

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

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

          <p>
            <strong>Example:</strong>
            2021-12-22T10:13:06.487Z
          </p>
        </td>
      </tr>

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

            <br />

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

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

          <p>
            <strong>Example:</strong>
            2021-12-22T10:13:06.487Z
          </p>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="mappingpoints">MappingPoints</h2>
  <p>One of:</p>

  <ol>
    <li>
      <a href="#mappingmultiply">MappingMultiply</a>
    </li>

    <li>
      <a href="#mappingfixed">MappingFixed</a>
    </li>
  </ol>

  <h2 id="mappingmultiply">MappingMultiply</h2>

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

    <tbody>
      <tr>
        <td>
          <p>
            type

            <br />

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

        <td>
          <p>Type of calculation.</p>

          <p>
            Available values:
            <code>MULTIPLY</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            multiplier

            <br />

            <code>number</code>
          </p>
        </td>

        <td>
          <p>Multiplication factor used to multiply the points to obtain the mapped points.</p>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="mappingfixed">MappingFixed</h2>

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

    <tbody>
      <tr>
        <td>
          <p>
            type

            <br />

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

        <td>
          <p>Type of calculation.</p>

          <p>
            Available values:
            <code>CUSTOM</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            points

            <br />

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

        <td>
          <p>Fixed number of points to be applied.</p>
        </td>
      </tr>
    </tbody>
  </table>
</div>