ON_ORDER_COMPLETED
Triggered when an order is completed
Payload
bodyobjectRequired
applied_couponsOrderCouponUsageDTO[]RequiredApplied coupons to this order
coupon_idstringRequired
usage_amountintegerRequired
applied_giftcardsOrderGiftCardUsageDTO[]RequiredApplied gift cards to this order
giftcard_idstringRequired
usage_amountintegerRequired
billing_address_countrystringRequired
The ISO-3316 Country Code of the customer associated with the order
billing_emailstringRequired
The billing email address of the customer associated with the order
billing_namestringRequired
The billing name of the customer associated with the order
checkoutCheckoutDTORequired
idstringRequired
The Flake ID of the Checkout
metadataobjectRequired
Metadata associated with the checkout
checkout_idstringRequired
The Flake ID of the Checkout associated with the order
completed_atstringRequired
Indicates when the order was completed
coupon_idstringRequired
The Flake ID of the Coupon associated with the order
created_atstringRequired
Indicates when the order was created
currencystringRequired
The ISO-4217 Currency Code of the order
customerCustomerDTORequired
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
→ MinecraftCustomerDTOprofileGenericProfileDTORequired
→ GenericProfileDTOsteamSteamCustomerDTORequired
→ SteamCustomerDTOnamestringOptional
customer_ipstringRequired
The IPv4 or IPv6 Address of the associated customer when creating the order
discount_amountintegerRequired
The discount amount, represented as cents
giftcard_usage_amountintegerRequired
The total amount of giftcard usage associated with the order, represented in cents
idstringRequired
The Flake ID of the Order
linesOrderLineDTO[]RequiredThe order lines associated with the order
discount_amountintegerRequired
The discount amount of the order line, represented in cents
idstringRequired
The Flake ID of the Order Line
priceintegerRequired
The price of the Order Line
productProductDTORequired
→ ProductDTOproduct_idstringRequired
The Flake ID of the Product ID associated with this Order Line
product_namestringRequired
The name of the product associated with this Order Line
product_version_idstringRequired
The Flake ID of the Product Version ID associated with this Order Line
quantityintegerRequired
The quantity of the Order Line
subtotal_amountintegerRequired
The subtotal amount of the order line, represented in cents
tax_amountintegerRequired
The tax amount of the order line, represented in cents
total_amountintegerRequired
The total amount of the order line, represented in cents
checkout_line_idstringOptional
The Flake ID of the Checkout Line associated with this Order Line
gift_to_customerCustomerDTOOptional
→ CustomerDTOproduct_image_urlstringOptional
The Image URL of the Product associated with this Order Line
selected_gameserver_idstringOptional
The Flake ID of which was the selected Game Server ID for the Order Line
subscription_idstringOptional
The Flake ID of the Subscription associated with this Order Line
subscription_interval_scalestringOptional
The value of the scale in which the subscription associated with this Order Line renews at
subscription_interval_valueintegerOptional
The value of the interval in which the subscription associated with this Order Line renews at
subscription_line_idstringOptional
The Flake ID of the Subscription Line associated with this Order Line
trial_idstringOptional
The Flake ID of the Trial associated with this Order Line
product_gameserversstringRequired
A comma-seperated string of the gameservers of the product associated with the order
product_namesstringRequired
A comma-seperated string of the names of the product associated with the order
product_tagsstringRequired
A comma-seperated string of the tags of the products associated with the order
statusstringRequired
The status of the Order. Possbile options: created, completed, canceled
store_idstringRequired
The Flake ID of the store associated with the order
subtotal_amountintegerRequired
The subtotal amount, represented as cents
tax_amountintegerRequired
The tax amount, represented as cents
tax_inclusivebooleanRequired
Indicates if the order value was inclusive of tax
total_amountintegerRequired
The total amount, represented as cents
typestringRequired
The type of the order
subscription_idstringOptional
The Flake ID of the Subscription associated with the order
event_idstringRequired
The ID of the Webhook Event
event_typeenumRequired
The type of webhook event
Possible enum values
ON_ORDER_COMPLETEDON_REFUNDON_CHARGEBACKON_CHARGEBACK_CLOSEDON_DELIVERY_ITEM_ADDEDON_DELIVERY_ITEM_ACTIVATEDON_DELIVERY_ITEM_USEDON_DELIVERY_ITEM_REVOKEDON_DELIVERY_ITEM_EXPIREDON_DELIVERY_ITEM_RENEWEDON_SUBSCRIPTION_ACTIVATEDON_SUBSCRIPTION_RENEWEDON_SUBSCRIPTION_CANCELEDON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUTON_CONNECTED_USER_REGISTEREDON_CONNECTED_USER_BECAME_PAYABLEON_CONNECTED_USER_BECAME_UNPAYABLEON_CONNECTED_USER_PAYOUT_CREATEDON_CONNECTED_USER_PAYOUT_COMPLETEDON_CONNECTED_USER_TRANSACTION_INSERTEDON_CONNECTED_USER_TRUST_STATUS_CHANGEDON_TRIAL_ACTIVATEDON_TRIAL_COMPLETEDON_TRIAL_CANCELEDON_PURCHASE_FOLLOW_UP_ATTEMPT_EMAIL_SENTON_PURCHASE_FOLLOW_UP_ATTEMPT_SUCCEEDEDON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_EMAIL_SENTON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_SUCCEEDEDON_PAYMENT_COMPLETEDON_PAYMENT_FAILED
Example payload
{
"event_type": "ON_ORDER_COMPLETED",
"event_id": "411486491630370816",
"body": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"customer": {
"id": "411486491630370816",
"steam": {
"id": "76561197960287930",
"name": "John",
"avatar_url": "string"
},
"minecraft": {
"id": "string",
"name": "Notch",
"avatar_url": "string"
},
"profile": {
"id": "string",
"platform": "string",
"name": "John",
"avatar_url": "string"
},
"name": "John"
},
"checkout_id": "411486491630370816",
"checkout": {
"id": "411486491630370816",
"metadata": {},
"lines": [
{
"id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"metadata": {}
}
]
},
"applied_coupons": [
{
"coupon_id": "411486491630370816",
"usage_amount": 0
}
],
"applied_giftcards": [
{
"giftcard_id": "411486491630370816",
"usage_amount": 0
}
],
"coupon_id": "411486491630370816",
"type": "one_time",
"currency": "USD",
"tax_inclusive": true,
"tax_amount": 1500,
"discount_amount": 500,
"subtotal_amount": 10000,
"total_amount": 11000,
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:35:00Z",
"billing_name": "John Doe",
"billing_email": "john@doe.com",
"billing_address_country": "US",
"customer_ip": "127.0.0.1/24",
"giftcard_usage_amount": 0,
"lines": [
{
"id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"product": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"slug": "string",
"name": "string",
"description": "string",
"enabled": true,
"sort_order": 0,
"price": 0,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"remove_after_enabled": true,
"tags": [
{
"id": "411486491630370816",
"slug": "string",
"name": "string"
}
],
"tag_names": "string",
"gameservers": [
{
"id": "411486491630370816",
"name": "string",
"enabled": true
}
],
"gameserver_names": "string",
"commands": [
{
"stage": "on_purchase",
"content": "string",
"online_only": true
}
],
"metadata": {},
"image_url": "string",
"label": "string",
"subscription_interval_value": 1,
"subscription_interval_scale": "month",
"remove_after_time_value": 1,
"remove_after_time_scale": "month",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
"product_name": "string",
"price": 1000,
"quantity": 1,
"discount_amount": 0,
"subtotal_amount": 1000,
"tax_amount": 100,
"total_amount": 1100,
"checkout_line_id": "411486491630370816",
"product_image_url": "string",
"subscription_id": "411486491630370816",
"subscription_line_id": "411486491630370816",
"subscription_interval_value": 1,
"subscription_interval_scale": "month",
"trial_id": "411486491630370816",
"gift_to_customer": {
"id": "411486491630370816",
"steam": {
"id": "76561197960287930",
"name": "John",
"avatar_url": "string"
},
"minecraft": {
"id": "string",
"name": "Notch",
"avatar_url": "string"
},
"profile": {
"id": "string",
"platform": "string",
"name": "John",
"avatar_url": "string"
},
"name": "John"
},
"selected_gameserver_id": "411486491630370816"
}
],
"product_names": "Product A, Product B",
"product_tags": "ranks, perks",
"product_gameservers": "game server one, game server two",
"status": "created",
"subscription_id": "411486491630370816"
}
}