customer.credits.expired

Triggered when a customer's credits have expired and are removed from their balance.

customer.credits.expired

Payload Structure

{
  "payload": {
    "merchantId": "inveterate",
    "customerId": "7733592490115",
    "newBalance": 0,
    "previousBalance": 5,
    "reason": "EXPIRED",
    "expiredAt": "2025-05-30T11:29:07.875Z",
    "email": "[email protected]",
    "firstName": "1",
    "lastName": "1",
    "amount": 5
  },
  "metadata": {
    "id": "e62649ec-851a-6f7a-1f78-fe9e66f8a81b",
    "retryCount": 0,
    "shopDomain": "inveterate.myshopify.com",
    "topic": "customer.credits.expired",
    "version": "2025-06",
    "triggerredAt": "2025-05-30T11:29:08.049Z"
  }
}

Payload Fields

payload

• merchantId (string): Merchant identifier

• customerId (string): Customer identifier

• email (string): Customer's email address

• firstName (string): Customer's first name

• lastName (string): Customer's last name

• amount (number): Amount of credits that expired

• newBalance (number): Customer's new credit balance after expiration

• previousBalance (number): Customer's credit balance before expiration

• reason (string): Reason for the credit change (always "EXPIRED" for this event)

• expiredAt (string): ISO timestamp when the credits expired

metadata

• id (string): Unique event identifier

• retryCount (number): Number of retry attempts for this event

• shopDomain (string): Shopify domain of the merchant

• topic (string): Event topic name

• version (string): API version

• triggerredAt (string): ISO timestamp when the event was triggered