Skip to main content
POST
/
EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.POINTS_EXPIRED
{
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "campaign": {
    "id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "name": "Loyalty programme",
    "campaign_type": "LOYALTY_PROGRAM",
    "type": "AUTO_UPDATE",
    "voucher": {
      "type": "LOYALTY_CARD",
      "loyalty_card": {
        "points": 0
      },
      "redemption": {
        "quantity": null
      },
      "code_config": {
        "length": 8,
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "########"
      }
    },
    "auto_join": false,
    "join_once": true,
    "active": true,
    "category_id": null,
    "metadata": {},
    "created_at": "2024-01-18T15:18:38.577Z",
    "updated_at": "2024-03-14T10:01:16.596Z",
    "object": "campaign"
  },
  "voucher": {
    "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
    "code": "L0y4L",
    "loyalty_card": {
      "points": 992,
      "balance": 262,
      "next_expiration_date": "2024-05-30"
    },
    "type": "LOYALTY_CARD",
    "campaign": "Loyalty programme",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "is_referral_code": false,
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "category_id": null,
    "active": true,
    "created_at": "2024-01-18T15:18:39.015Z",
    "updated_at": "2024-03-15T00:02:09.334Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 7,
      "redeemed_points": 730
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "points": 70,
  "buckets": [
    {
      "id": "lopb_wQey6iuachtxVonzt51V01Qx",
      "voucher_id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
      "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
      "bucket": {
        "total_points": 70
      },
      "status": "ACTIVE",
      "expires_at": "2024-03-14",
      "created_at": "2024-03-13T17:39:56.818Z",
      "updated_at": "2024-03-14T15:29:33.239Z",
      "object": "loyalty_points_bucket"
    }
  ],
  "transaction": {
    "id": "vtx_0e719686512773b205",
    "source_id": null,
    "voucher_id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "source": "Automation",
    "reason": null,
    "type": "POINTS_EXPIRATION",
    "details": {
      "balance": {
        "type": "loyalty_card",
        "total": 992,
        "object": "balance",
        "points": -70,
        "balance": 262,
        "related_object": {
          "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
          "type": "voucher"
        }
      }
    },
    "related_transaction_id": null,
    "created_at": "2024-03-15T00:02:09.334Z"
  }
}

Response

200 - application/json

Indicates that points have expired on a customer's loyalty card.

Event data object schema for customer.voucher.loyalty_card.points_expired.

​
customer
object
required

Simplified customer data.

​
campaign
object
required

Simplified campaign data.

​
voucher
object
required

Simplified voucher data.

​
points
integer
required

Indicates the number of points that expired.

​
buckets
Loyalty Point Bucket · object[]
required
​
transaction
object
required

Transaction details of the voucher.

⌘I