post https://example.com/EVENTS.CUSTOMER.ORDER.PAID
EVENT: "EVENTS.CUSTOMER.ORDER.PAID"
HTTP method: POST
HTTP method: POST
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.
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.
Example: 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
}