customer.payment_succeeded

Triggered when a customer's payment is successfully processed.

customer.payment_succeeded

Payload Structure

{
  "payload": {
    "customerId": "7733576892547",
    "merchantId": "inveterate",
    "createdAt": "2025-05-30T11:07:59.269Z",
    "updatedAt": "2025-05-30T11:07:59.269Z",
    "status": "PAID",
    "detail": {
      "amount": 100,
      "currency": "USD",
      "newBillingDate": "2025-07-30T00:00:00.000Z"
    },
    "customer": {
      "id": "7733576892547",
      "email": "[email protected]",
      "phoneNumber": null
    }
  },
  "metadata": {
    "id": "4b3922a9-e878-3947-b283-57dfbd97d86c",
    "retryCount": 0,
    "shopDomain": "inveterate.myshopify.com",
    "topic": "customer.payment_succeeded",
    "version": "2025-06",
    "triggerredAt": "2025-05-30T11:07:59.279Z"
  }
}

Payload Fields

payload

• createdAt (string): ISO timestamp when the event was created

• updatedAt (string): ISO timestamp when the event was last updated

• merchantId (string): Merchant identifier

• customerId (string): Customer identifier

• status (string): Payment status (e.g., "PAID")

• detail (object): Payment details

  • amount (number): Payment amount

  • currency (string): Currency code (e.g., "USD")

  • newBillingDate (string): ISO timestamp for the next billing date

• customer (object): Customer information

  • id (string): Customer identifier

  • email (string): Customer's email address

  • phoneNumber (string|null): Customer's phone number

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