Order Webhooks
Order Webhook Payload
API Reference
- Getting Started
- Webhooks
- Usage
- Manage My Subscription
Order Webhooks
Order Webhook Payload
Example
JSON
{
"order": {
"agreement_number": 1,
"billing_schedule": "annually",
"buyer": {
"address": {
"city": "Address City",
"country": "Address Country",
"id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"line_1": "123 Address Line 1",
"line_2": "Address Line 2 ",
"region": "Address Region",
"zip": "00000"
},
"name": "Example Co."
},
"chain_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"closed_at": null,
"created_at": "2023-12-28T01:43:21.807242Z",
"current_order_skus": [
{
"quantity": 1,
"sku": {
"code": "OrderBrickCode",
"id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"name": "OrderBrick"
}
}
],
"ends_at": "2024-12-28T23:59:59.999+00:00",
"grand_total": 100,
"id": "9fdf8866-f3c0-4cee-beb1-20c7d39528c7",
"metadata": {},
"order_type": "standard",
"primary_user": {
"company": {
"address": {
"city": "Address City",
"country": "Address Country",
"id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"line_1": "123 Address Line 1",
"line_2": "Address Line 2 ",
"region": "Address Region",
"zip": "00000"
},
"name": "Example Co."
},
"email": "buyername@buyer.com",
"first_name": "BuyerFirstName",
"last_name": "BuyerLastName"
},
"stage": "building",
"starts_at": "2023-12-29T00:00:00.000+00:00",
"updated_at": "2023-12-28T02:43:20.807242Z",
"terminated_at": "2024-01-20T02:00:20.805487Z"
}
}