Lantern
Liquid API

birth_date

Access the customer's birth date for personalized experiences and birthday campaigns.

Syntax

customer.metafields.facts.birth_date

Description

The birth_date metafield contains the customer's birth date in ISO format (YYYY-MM-DD). This data can be used for birthday campaigns, age-based promotions, and personalized experiences.

Birth date uses the facts namespace (not lantern) and follows ISO 8601 date format.

Properties

Type: Date (ISO 8601 String) Namespace: facts

Return Values

ScenarioValueType
Birth date providedDate string (e.g., "1990-05-15")String
No birth datenullnull
Logged outnullnull

Examples

Basic Birthday Display

{% assign birth_date = customer.metafields.facts.birth_date %}
{% if birth_date %}
  {% assign birthday = birth_date | date: '%B %d' %}
  <p>Birthday: {{ birthday }}</p>
{% endif %}