Order Paid

WEBHOOK EVENTS.CUSTOMER.ORDER.PAID

customer.order.paid

{
  "customer": {
    "id": "cust_ufwK2qUNGDYxa1aji7XKzuHm",
    "name": "Alex Doe",
    "email": null,
    "source_id": "4l3x-d03",
    "metadata": {},
    "object": "customer"
  },
  "referrer": null,
  "order": {
    "id": "ord_au8U64mPX6fIArsf6UVLS8u5",
    "source_id": null,
    "created_at": "2024-03-11T13:20:39.987Z",
    "updated_at": "2024-03-11T13:20:39.988Z",
    "status": "PAID",
    "amount": 10000,
    "total_amount": 10000,
    "items": [
      {
        "object": "order_item",
        "product_id": "prod_0df14b7e7d8975079d",
        "quantity": 4,
        "amount": 10000,
        "price": 2500,
        "subtotal_amount": 10000,
        "product": {
          "name": "Star Thermal Bottle",
          "price": 2500
        }
      },
      {
        "object": "order_item",
        "product_id": "prod_5h1pp1ng",
        "quantity": 1,
        "amount": 0,
        "price": 0,
        "subtotal_amount": 0,
        "product": {
          "name": "Shipping"
        }
      }
    ],
    "metadata": {
      "card": [
        "Other"
      ],
      "region": "US",
      "currency": "USD"
    },
    "customer": {
      "id": "cust_ufwK2qUNGDYxa1aji7XKzuHm",
      "address": null,
      "summary": null,
      "loyalty": null,
      "referrals": null,
      "object": "customer"
    },
    "customer_id": "cust_ufwK2qUNGDYxa1aji7XKzuHm",
    "referrer_id": null,
    "object": "order"
  },
  "redemption": null
}

The EVENTS.CUSTOMER.ORDER.PAID event indicates that a customer-related order has been paid.

When the event is used in an “Order has been paid” distribution webhook, the data object always contains the following required objects:

• customer,
• referrer,
• order,
• redemption.

Additional objects are also sent depending on the purpose:

• “Notify customers about promotion” sends also the following objects:
  • campaign,
  • promotion_tier,
• “Send and publish unique codes from campaign” sends also the following objects:
  • campaign,
  • voucher,
  • publication,
• “Send plain message to customers” sends only the basic objects listed above.

This event is used in a webhook configured in Distributions in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for customer.order.paid.

customer · Simple Customer · object · required

Simplified customer data.

Show child attributes

referrer · Simple Customer · object · required

Simplified customer data.

Show child attributes

order · Order Calculated · object · required

Order information.

Show child attributes

redemption · Redemption Internal · object · required

Redemption data used for internal communication

Show child attributes

campaign · Simple Campaign · object

Details about the campaign related to the distribution with a promotion or send voucher purpose.

Show child attributes

voucher · Simple Voucher · object

Details about the voucher related to the distribution with a send voucher purpose.

Show child attributes

publication · Publications Item Base · object

Details about the publication related to the distribution with a send voucher purpose.

Show child attributes

promotion_tier · Simple Promotion Tier · object

Details about the promotion tier related to the distribution with a promotion purpose.

Show child attributes

Response

200

Webhook accepted