For orders created through Universal Commerce Protocol (UCP), data.object.metadata.checkoutId identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, data.object.merchantReferenceId contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, merchantReferenceId is omitted from the UCP terminal event.
Hex-encoded HMAC-SHA256 signature generated with the webhook signing secret over the string ${X-Clink-Timestamp}.${rawRequestBody}. Use the raw request body bytes/string exactly as received; do not parse and re-serialize the JSON before verifying.
Return a 200 status to indicate that the data was received successfully.
Account response
Only needed for orders that buy credits on your service, such as a top-up bought through a Skill Marketplace Skill. When order.succeeded arrives for such an order, create or top up the user's account, then return the result in the response body.
type
Return it when
account.created
No account matched data.object.customerEmail. You created the account and applied the purchase as its first top-up.
account.reloaded
An existing account matched data.object.customerEmail, and you applied the purchase to it.
Must match data.object.customerEmail in the event.
data.webSite
Your website's absolute URL, including http:// or https://.
data.userId
The user's ID in your system, not the Clink customerId.
data.amount
Copy data.object.amountTotal from the event.
data.currency
Copy data.object.paymentCurrency from the event.
Commit the account change before you respond. A non-2xx status or a timeout makes Clink retry the event.
Deduplicate on the event id. For a repeated delivery, return the stored response without creating another account or applying the top-up again.
Clink uses this body only for orders paid through Agent Payment, and makes the result available to the buyer's agent. For other orders and other order events, an empty body is enough.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Clink Documentation","colors":{"primary":"#FF9472"},"logo":{"light":"https://mintcdn.com/clink/SmNnnZK50PsVdBCU/logo/light_new.svg?fit=max\u0026auto=format\u0026n=SmNnnZK50PsVdBCU\u0026q=85\u0026s=9956e279765b6e968dcc19748a3ee896","dark":"https://mintcdn.com/clink/SmNnnZK50PsVdBCU/logo/dark_new.svg?fit=max\u0026auto=format\u0026n=SmNnnZK50PsVdBCU\u0026q=85\u0026s=e447d25bef8f25b8da7fbbe78e04ef92"},"favicon":"https://mintcdn.com/clink/peBNaRlFWIQS8vOQ/favicon.svg?fit=max\u0026auto=format\u0026n=peBNaRlFWIQS8vOQ\u0026q=85\u0026s=c6eb5684668bd21139f01cb68bd69932","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","java","python","javascript"]}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://uat-dashboard.clinkbill.com","label":"Sandbox"},{"href":"mailto:contact@clinkbill.com","label":"Support"},{"href":"https://github.com/clinkbillcom/clink-integ-skills","label":"Integration-skill"},{"href":"https://docs.clinkbill.com/llms.txt","label":"llms.txt"},{"href":"https://docs.clinkbill.com/llms-full.txt","label":"llms-full.txt"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.clinkbill.com"}},"footer":{"socials":{"x":"https://x.com/clink_bill","linkedin":"https://linkedin.com/company/clinkbill"}},"icons":{"library":"lucide"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"cn","href":"cn"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clink","hasAudioNarration":false,"actualSubdomain":"clink","customDomains":["docs.clinkbill.com"],"gitSource":{"type":"github","owner":"pppatrickkkk","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af4694a8aa693fcd6be42fd","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"en","tag":"Documentation","count":41},{"language":"cn","tag":"知识库","count":41},{"language":"default","tag":"API Reference","count":36},{"language":"en","tag":"API Reference","count":35},{"language":"cn","tag":"API 文档","count":35},{"language":"en","tag":"Guides","count":14},{"language":"cn","tag":"介绍","count":14},{"language":"en","tag":"Agent Solutions","count":11},{"language":"cn","tag":"Agent 解决方案","count":11},{"language":"default","tag":"Webhook Endpoint Management","count":10},{"language":"default","tag":"Webhooks","count":7},{"language":"en","tag":"Core Resource","count":6},{"language":"cn","tag":"资源说明","count":6},{"language":"en","tag":"Integration","count":5},{"language":"en","tag":"Promotion Code","count":5},{"language":"en","tag":"Clink MCP","count":5},{"language":"en","tag":"Get Started","count":5},{"language":"en","tag":"Choose your integration","count":5},{"language":"default","tag":"Test Clock","count":5},{"language":"cn","tag":"接入","count":5},{"language":"cn","tag":"Promotion Code","count":5},{"language":"cn","tag":"Clink MCP","count":5},{"language":"cn","tag":"开始使用","count":5},{"language":"cn","tag":"选择接入方案","count":5},{"language":"default","tag":"Subscription","count":3},{"language":"default","tag":"Checkout Session","count":3},{"language":"default","tag":"Agent Payment Session","count":2},{"language":"default","tag":"Price","count":2},{"language":"default","tag":"Product","count":2},{"language":"default","tag":"Order","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/webhook/order","slug":"/api-reference/webhook/order","pageMetadata":{"title":"order","openapi":"WEBHOOK order","description":"Handles order lifecycle events.\n\nFor orders created through Universal Commerce Protocol (UCP), `data.object.metadata.checkoutId` identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, `data.object.merchantReferenceId` contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, `merchantReferenceId` is omitted from the UCP terminal event.","href":"/api-reference/webhook/order"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Handles order lifecycle events.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For orders created through Universal Commerce Protocol (UCP), \", _jsx(_components.code, {\n children: \"data.object.metadata.checkoutId\"\n }), \" identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, \", _jsx(_components.code, {\n children: \"data.object.merchantReferenceId\"\n }), \" contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, \", _jsx(_components.code, {\n children: \"merchantReferenceId\"\n }), \" is omitted from the UCP terminal event.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"order","openapi":"WEBHOOK order","description":"Handles order lifecycle events.\n\nFor orders created through Universal Commerce Protocol (UCP), `data.object.metadata.checkoutId` identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, `data.object.merchantReferenceId` contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, `merchantReferenceId` is omitted from the UCP terminal event.","href":"/api-reference/webhook/order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Handles order lifecycle events.\n\nFor orders created through Universal Commerce Protocol (UCP), `data.object.metadata.checkoutId` identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, `data.object.merchantReferenceId` contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, `merchantReferenceId` is omitted from the UCP terminal event.","security":[],"parameters":["f49fbb89-c3e0-44b4-b68c-61c9b84c1fc4","c7b37299-7f59-462b-b407-c5c8085f15e8","97321768-a6d6-46e4-90dd-396d143eae53"],"requestBody":"4df77486-06bc-421a-9bd1-bfa5cfaa2d68","responses":{"200":"22acdbb9-18ad-40d6-8b50-ae104c4a664e"},"method":"post","type":"webhook","servers":["7ce95461-a04d-43b4-a136-137963aec4b4"],"path":"order","baseUrlOptions":["https://uat-api.clinkbill.com/api/"],"title":"","codeSamples":[],"requestExampleLanguages":["bash","java","python","javascript"],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"cardPayment","code":"{\n \"id\": \"event_xxxxx\",\n \"object\": \"event\",\n \"created\": 1750062041000,\n \"type\": \"order.succeeded\",\n \"data\": {\n \"object\": {\n \"orderId\": \"order_xxxxx\",\n \"sessionId\": \"sess_xxxxx\",\n \"type\": \"onetime\",\n \"merchantReferenceId\": \"pay_ref_123\",\n \"customerId\": \"cus_xxxxx\",\n \"customerEmail\": \"customer@example.com\",\n \"amountSubtotal\": 19.99,\n \"amountTotal\": 9.99,\n \"paymentCurrency\": \"USD\",\n \"originalCurrency\": \"USD\",\n \"discount\": {\n \"couponId\": \"coupon_1\",\n \"couponName\": \"Ten off\",\n \"couponTerms\": \"10 USD off\",\n \"promotionCode\": \"SAVE10\",\n \"discountAmount\": 10,\n \"originalDiscountAmount\": 10\n },\n \"status\": \"success\",\n \"paymentTime\": 1750062041000,\n \"paymentMethod\": {\n \"paymentMethodType\": \"CARD\",\n \"paymentInstrumentId\": \"pi_xxxxx\",\n \"cardScheme\": \"Visa\",\n \"cardLastFour\": \"4242\",\n \"issuerRegion\": \"US\",\n \"issuerBank\": \"Chase Bank\"\n },\n \"metadata\": {\n \"orderNo\": \"ORDER-10001\"\n }\n }\n }\n}"},{"language":"json","filename":"walletPayment","code":"{\n \"id\": \"event_xxxxx\",\n \"object\": \"event\",\n \"created\": 1750148441000,\n \"type\": \"order.succeeded\",\n \"data\": {\n \"object\": {\n \"orderId\": \"order_xxxxx\",\n \"sessionId\": \"sess_xxxxx\",\n \"type\": \"onetime\",\n \"merchantReferenceId\": \"pay_ref_124\",\n \"customerId\": \"cus_xxxxx\",\n \"customerEmail\": \"customer@example.com\",\n \"amountSubtotal\": 19.99,\n \"amountTotal\": 9.99,\n \"paymentCurrency\": \"USD\",\n \"originalCurrency\": \"USD\",\n \"discount\": {\n \"couponId\": \"coupon_1\",\n \"couponName\": \"Ten off\",\n \"couponTerms\": \"10 USD off\",\n \"promotionCode\": \"SAVE10\",\n \"discountAmount\": 10,\n \"originalDiscountAmount\": 10\n },\n \"status\": \"success\",\n \"paymentTime\": 1750148441000,\n \"paymentMethod\": {\n \"paymentMethodType\": \"PAYPAL\",\n \"paymentInstrumentId\": \"pi_xxxxx\",\n \"wallet\": {\n \"accountTag\": \"s*****@personal.example.com\"\n }\n },\n \"metadata\": {\n \"orderNo\": \"ORDER-10002\"\n }\n }\n }\n}"},{"language":"json","filename":"failedCardPayment","code":"{\n \"id\": \"event_xxxxx\",\n \"object\": \"event\",\n \"created\": 1750234841000,\n \"type\": \"order.failed\",\n \"data\": {\n \"object\": {\n \"orderId\": \"order_xxxxx\",\n \"sessionId\": \"sess_xxxxx\",\n \"type\": \"onetime\",\n \"merchantReferenceId\": \"pay_ref_125\",\n \"customerId\": \"cus_xxxxx\",\n \"customerEmail\": \"customer@example.com\",\n \"amountSubtotal\": 19.99,\n \"amountTotal\": 9.99,\n \"paymentCurrency\": \"USD\",\n \"originalCurrency\": \"USD\",\n \"discount\": {\n \"couponId\": \"coupon_1\",\n \"couponName\": \"Ten off\",\n \"couponTerms\": \"10 USD off\",\n \"promotionCode\": \"SAVE10\",\n \"discountAmount\": 10,\n \"originalDiscountAmount\": 10\n },\n \"status\": \"failed\",\n \"paymentTime\": 1750234841000,\n \"failureCode\": \"card_declined\",\n \"failureMessage\": \"The card was declined\",\n \"paymentMethod\": {\n \"paymentMethodType\": \"CARD\",\n \"paymentInstrumentId\": \"pi_xxxxx\",\n \"cardScheme\": \"Visa\",\n \"cardLastFour\": \"4242\",\n \"issuerRegion\": \"US\",\n \"issuerBank\": \"Chase Bank\"\n },\n \"metadata\": {\n \"orderNo\": \"ORDER-10003\"\n }\n }\n }\n}"},{"language":"json","filename":"ucpOrderSucceeded","code":"{\n \"id\": \"event_xxxxx\",\n \"object\": \"event\",\n \"created\": 1750321241000,\n \"type\": \"order.succeeded\",\n \"data\": {\n \"object\": {\n \"orderId\": \"order_xxxxx\",\n \"sessionId\": null,\n \"type\": \"onetime\",\n \"merchantReferenceId\": \"merchant_order_xxxxx\",\n \"customerId\": \"cus_xxxxx\",\n \"customerEmail\": \"customer@example.com\",\n \"amountSubtotal\": 19.99,\n \"amountTotal\": 9.99,\n \"paymentCurrency\": \"USD\",\n \"originalCurrency\": \"USD\",\n \"discount\": {\n \"couponId\": \"coupon_1\",\n \"couponName\": \"Ten off\",\n \"couponTerms\": \"10 USD off\",\n \"promotionCode\": \"SAVE10\",\n \"discountAmount\": 10,\n \"originalDiscountAmount\": 10\n },\n \"status\": \"success\",\n \"paymentTime\": 1750321241000,\n \"paymentMethod\": {\n \"paymentMethodType\": \"CARD\",\n \"paymentInstrumentId\": \"pi_xxxxx\",\n \"cardScheme\": \"Visa\",\n \"cardLastFour\": \"4242\"\n },\n \"metadata\": {\n \"checkoutId\": \"chk_xxxxx\"\n }\n }\n }\n}"},{"language":"json","filename":"ucpOrderFailed","code":"{\n \"id\": \"event_xxxxx\",\n \"object\": \"event\",\n \"created\": 1750407641000,\n \"type\": \"order.failed\",\n \"data\": {\n \"object\": {\n \"orderId\": \"order_xxxxx\",\n \"sessionId\": null,\n \"type\": \"onetime\",\n \"merchantReferenceId\": \"merchant_order_xxxxx\",\n \"customerId\": \"cus_xxxxx\",\n \"customerEmail\": \"customer@example.com\",\n \"amountSubtotal\": 19.99,\n \"amountTotal\": 9.99,\n \"paymentCurrency\": \"USD\",\n \"originalCurrency\": \"USD\",\n \"discount\": {\n \"couponId\": \"coupon_1\",\n \"couponName\": \"Ten off\",\n \"couponTerms\": \"10 USD off\",\n \"promotionCode\": \"SAVE10\",\n \"discountAmount\": 10,\n \"originalDiscountAmount\": 10\n },\n \"status\": \"failed\",\n \"paymentTime\": 1750407641000,\n \"failureCode\": \"card_declined\",\n \"failureMessage\": \"The card was declined\",\n \"paymentMethod\": {\n \"paymentMethodType\": \"CARD\",\n \"paymentInstrumentId\": \"pi_xxxxx\",\n \"cardScheme\": \"Visa\",\n \"cardLastFour\": \"4242\"\n },\n \"metadata\": {\n \"checkoutId\": \"chk_xxxxx\"\n }\n }\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"f49fbb89-c3e0-44b4-b68c-61c9b84c1fc4":{"name":"X-Clink-Timestamp","in":"header","description":"Timestamp sent by Clink for webhook signature verification.","required":true,"schema":{"type":"string","isRequired":true,"description":"Timestamp sent by Clink for webhook signature verification.","uniqueKey":"","typeLabel":"string"}},"c7b37299-7f59-462b-b407-c5c8085f15e8":{"name":"X-Clink-Signature","in":"header","description":"Hex-encoded HMAC-SHA256 signature generated with the webhook signing secret over the string `${X-Clink-Timestamp}.${rawRequestBody}`. Use the raw request body bytes/string exactly as received; do not parse and re-serialize the JSON before verifying.","required":true,"schema":{"type":"string","isRequired":true,"description":"Hex-encoded HMAC-SHA256 signature generated with the webhook signing secret over the string `${X-Clink-Timestamp}.${rawRequestBody}`. Use the raw request body bytes/string exactly as received; do not parse and re-serialize the JSON before verifying.","uniqueKey":"","typeLabel":"string"}},"97321768-a6d6-46e4-90dd-396d143eae53":{"name":"X-Clink-SignType","in":"header","description":"Signature algorithm used to generate X-Clink-Signature. The current value is SHA256.","required":true,"schema":{"type":"string","enum":["SHA256"],"isRequired":true,"description":"Signature algorithm used to generate X-Clink-Signature. The current value is SHA256.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"description":"Order event payload in json","content":{"application/json":{"schema":{"type":"object","required":["id","object","created","type","data"],"properties":{"id":{"type":"string","description":"Unique identifier for the event","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","enum":["order.created","order.next_action","order.succeeded","order.failed"],"description":"Type of event that occurred","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"object":{"type":"string","example":"event","description":"Type of this json payload, 'event' if this is an event","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"created":{"type":"integer","format":"int64","description":"Unix timestamp in milliseconds when the event occurred","isRequired":true,"uniqueKey":"created","typeLabel":"integer\u003cint64>"},"data":{"type":"object","required":["object"],"properties":{"object":{"type":"object","properties":{"orderId":{"type":"string","description":"Unique identifier of the order","uniqueKey":"data.object.orderId","typeLabel":"string"},"type":{"type":"string","enum":["recurring","onetime"],"description":"Order type. `recurring` is a subscription order and `onetime` is a one-time payment order.","uniqueKey":"data.object.type","typeLabel":"enum\u003cstring>"},"merchantReferenceId":{"oneOf":[{"type":"string","description":"Merchant's internal reference ID for the order. For a UCP order created through a connected merchant order channel, this is the merchant-side order ID returned when OMS creates the third-party order, not an OMS internal order ID. If no third-party merchant order was created, this value is null in UCP `order.created` and `order.next_action` events and in order retrieval responses; the property is omitted from UCP `order.succeeded` and `order.failed` events.","uniqueKey":"data.object.merchantReferenceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's internal reference ID for the order. For a UCP order created through a connected merchant order channel, this is the merchant-side order ID returned when OMS creates the third-party order, not an OMS internal order ID. If no third-party merchant order was created, this value is null in UCP `order.created` and `order.next_action` events and in order retrieval responses; the property is omitted from UCP `order.succeeded` and `order.failed` events.","uniqueKey":"data.object.merchantReferenceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.merchantReferenceId","typeLabel":"string | null"},"invoiceId":{"type":"string","description":"Associated invoice identifier","uniqueKey":"data.object.invoiceId","typeLabel":"string"},"customerId":{"type":"string","description":"Customer identifier associated with the order","uniqueKey":"data.object.customerId","typeLabel":"string"},"customerEmail":{"type":"string","description":"Customer email address associated with the order","uniqueKey":"data.object.customerEmail","typeLabel":"string"},"productId":{"type":"string","description":"Product identifier for the ordered item","uniqueKey":"data.object.productId","typeLabel":"string"},"priceId":{"type":"string","description":"Price configuration identifier used for the order","uniqueKey":"data.object.priceId","typeLabel":"string"},"priceDataList":{"type":"array","description":"List of pricing details for items in the order","items":{"required":["name","unitAmount"],"type":"object","properties":{"name":{"type":"string","description":"Display name of the product shown to customers during checkout","isRequired":true,"uniqueKey":"data.object.priceDataList.items.[INDEX].name","typeLabel":"string"},"unitAmount":{"minimum":0,"exclusiveMinimum":true,"type":"number","description":"Price per unit in the specified currency (must be greater than 0)","isRequired":true,"uniqueKey":"data.object.priceDataList.items.[INDEX].unitAmount","typeLabel":"number"},"quantity":{"minimum":1,"type":"integer","description":"Number of units to be purchased (minimum 1)","format":"int32","uniqueKey":"data.object.priceDataList.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"currency":{"type":"string","description":"Three-letter ISO currency code for the price (e.g., USD, EUR, GBP)","uniqueKey":"data.object.priceDataList.items.[INDEX].currency","typeLabel":"string"},"imageUrl":{"type":"string","description":"URL of the product image to display during checkout","uniqueKey":"data.object.priceDataList.items.[INDEX].imageUrl","typeLabel":"string"},"productUrl":{"type":"string","maxLength":2048,"description":"URL of the product page for this line item. Renders that product name as a link in the receipt email and takes precedence over the session-level productUrl. Must start with http:// or https:// (scheme is case-insensitive) and be at most 2048 characters. Requests whose productUrl uses any other scheme are rejected.","uniqueKey":"data.object.priceDataList.items.[INDEX].productUrl","typeLabel":"string"}},"uniqueKey":"data.object.priceDataList.items.[INDEX]","typeLabel":"object"},"refType":"PriceData","uniqueKey":"data.object.priceDataList","typeLabel":"object[]"},"paymentMethod":{"type":"object","properties":{"paymentMethodType":{"type":"string","example":"CARD","description":"Type of payment method used (e.g., CARD)","uniqueKey":"data.object.paymentMethod.paymentMethodType","typeLabel":"string"},"paymentInstrumentId":{"type":"string","description":"Unique identifier of the specific payment instrument","uniqueKey":"data.object.paymentMethod.paymentInstrumentId","typeLabel":"string"},"cardScheme":{"type":"string","example":"Visa","description":"Card brand or scheme, such as Visa or Mastercard","uniqueKey":"data.object.paymentMethod.cardScheme","typeLabel":"string"},"cardLastFour":{"type":"string","example":"4242","description":"Last four digits of the card","uniqueKey":"data.object.paymentMethod.cardLastFour","typeLabel":"string"},"issuerRegion":{"type":"string","example":"US","description":"Card issuing country or region","uniqueKey":"data.object.paymentMethod.issuerRegion","typeLabel":"string"},"issuerBank":{"type":"string","example":"Chase Bank","description":"Card issuing bank","uniqueKey":"data.object.paymentMethod.issuerBank","typeLabel":"string"},"wallet":{"type":"object","description":"Wallet account information for wallet-based payment methods","properties":{"accountTag":{"type":"string","example":"s*****@personal.example.com","description":"Bound wallet account tag or reference","uniqueKey":"data.object.paymentMethod.wallet.accountTag","typeLabel":"string"}},"uniqueKey":"data.object.paymentMethod.wallet","typeLabel":"object"}},"description":"Payment method details used for the order","uniqueKey":"data.object.paymentMethod","typeLabel":"object"},"paymentExecutionDetails":{"type":"array","description":"Payment execution details for platform-managed payment attempts","items":{"type":"object","properties":{"channelCode":{"type":"string","description":"Payment channel code","uniqueKey":"data.object.paymentExecutionDetails.items.[INDEX].channelCode","typeLabel":"string"},"channelTransactionId":{"type":"string","description":"Transaction identifier returned by the payment channel","uniqueKey":"data.object.paymentExecutionDetails.items.[INDEX].channelTransactionId","typeLabel":"string"},"originalFailureCode":{"type":"string","description":"Original failure code returned by the payment channel","uniqueKey":"data.object.paymentExecutionDetails.items.[INDEX].originalFailureCode","typeLabel":"string"},"originalFailureMessage":{"type":"string","description":"Original failure message returned by the payment channel","uniqueKey":"data.object.paymentExecutionDetails.items.[INDEX].originalFailureMessage","typeLabel":"string"}},"uniqueKey":"data.object.paymentExecutionDetails.items.[INDEX]","typeLabel":"object"},"refType":"PaymentExecutionDetailApiVo","uniqueKey":"data.object.paymentExecutionDetails","typeLabel":"object[]"},"amountSubtotal":{"type":"number","example":9.99,"description":"Order subtotal before taxes and adjustments","uniqueKey":"data.object.amountSubtotal","typeLabel":"number"},"amountTotal":{"type":"number","example":9.99,"description":"Final order amount including all adjustments","uniqueKey":"data.object.amountTotal","typeLabel":"number"},"discount":{"type":"object","properties":{"couponId":{"type":"string","example":"coupon_1","description":"Applied coupon ID.","uniqueKey":"data.object.discount.couponId","typeLabel":"string"},"couponName":{"type":"string","example":"Ten off","description":"Coupon name.","uniqueKey":"data.object.discount.couponName","typeLabel":"string"},"couponTerms":{"type":"string","example":"10 USD off","description":"Human-readable coupon terms.","uniqueKey":"data.object.discount.couponTerms","typeLabel":"string"},"promotionCode":{"type":"string","example":"SAVE10","description":"Promotion code applied to the order.","uniqueKey":"data.object.discount.promotionCode","typeLabel":"string"},"discountAmount":{"type":"number","example":10,"description":"Discount amount in the payment currency, corresponding to `paymentCurrency`.","uniqueKey":"data.object.discount.discountAmount","typeLabel":"number"},"originalDiscountAmount":{"type":"number","example":10,"description":"Discount amount in the original currency, corresponding to `originalCurrency`.","uniqueKey":"data.object.discount.originalDiscountAmount","typeLabel":"number"}},"description":"Discount information applied to the order. Omitted when the order has no discount.","uniqueKey":"data.object.discount","typeLabel":"object"},"paymentCurrency":{"type":"string","example":"USD","description":"Currency used for payment processing","uniqueKey":"data.object.paymentCurrency","typeLabel":"string"},"originalCurrency":{"type":"string","example":"USD","description":"Original currency of the order","uniqueKey":"data.object.originalCurrency","typeLabel":"string"},"status":{"type":"string","enum":["success","failed","requires_action","pending","partial_refunded","refunded"],"description":"Current status of the order","uniqueKey":"data.object.status","typeLabel":"enum\u003cstring>"},"failureCode":{"type":"string","example":"card_declined","description":"Standardized failure code for a failed order. Returned only when the order is failed and Clink can resolve a standardized failure reason.","uniqueKey":"data.object.failureCode","typeLabel":"string"},"failureMessage":{"type":"string","example":"The card was declined","description":"Standardized failure message for a failed order. Returned only when the order is failed and Clink can resolve a standardized failure reason.","uniqueKey":"data.object.failureMessage","typeLabel":"string"},"paymentTime":{"type":"integer","example":1754819711382,"description":"Unix timestamp when the order payment reached a final success or failed state","format":"int64","uniqueKey":"data.object.paymentTime","typeLabel":"integer\u003cint64>"},"sessionId":{"oneOf":[{"type":"string","description":"Unique identifier for the checkout session. Null when the order was created through a flow that does not use a Clink checkout session, such as a UCP agent order.","uniqueKey":"data.object.sessionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier for the checkout session. Null when the order was created through a flow that does not use a Clink checkout session, such as a UCP agent order.","uniqueKey":"data.object.sessionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.object.sessionId","typeLabel":"string | null"},"metadata":{"type":"object","properties":{"checkoutId":{"type":"string","example":"chk_xxxxx","description":"Checkout ID that originated the UCP order. Present in order metadata throughout the UCP order lifecycle, including `order.created`, `order.next_action`, `order.succeeded`, and `order.failed` events, and in order retrieval responses.","uniqueKey":"data.object.metadata.checkoutId","typeLabel":"string"}},"additionalProperties":{"type":"string","uniqueKey":"data.object.metadata.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs attached to the order. For UCP orders, this object includes `checkoutId` throughout the order lifecycle and in order retrieval responses.","uniqueKey":"data.object.metadata","typeLabel":"object"},"riskLevel":{"type":"string","description":"Risk level detected for the order","uniqueKey":"data.object.riskLevel","typeLabel":"string"}},"description":"Order payload object","isRequired":true,"uniqueKey":"data.object","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"cardPayment":{"title":"cardPayment","value":{"id":"event_xxxxx","object":"event","created":1750062041000,"type":"order.succeeded","data":{"object":{"orderId":"order_xxxxx","sessionId":"sess_xxxxx","type":"onetime","merchantReferenceId":"pay_ref_123","customerId":"cus_xxxxx","customerEmail":"customer@example.com","amountSubtotal":19.99,"amountTotal":9.99,"paymentCurrency":"USD","originalCurrency":"USD","discount":{"couponId":"coupon_1","couponName":"Ten off","couponTerms":"10 USD off","promotionCode":"SAVE10","discountAmount":10,"originalDiscountAmount":10},"status":"success","paymentTime":1750062041000,"paymentMethod":{"paymentMethodType":"CARD","paymentInstrumentId":"pi_xxxxx","cardScheme":"Visa","cardLastFour":"4242","issuerRegion":"US","issuerBank":"Chase Bank"},"metadata":{"orderNo":"ORDER-10001"}}}}},"walletPayment":{"title":"walletPayment","value":{"id":"event_xxxxx","object":"event","created":1750148441000,"type":"order.succeeded","data":{"object":{"orderId":"order_xxxxx","sessionId":"sess_xxxxx","type":"onetime","merchantReferenceId":"pay_ref_124","customerId":"cus_xxxxx","customerEmail":"customer@example.com","amountSubtotal":19.99,"amountTotal":9.99,"paymentCurrency":"USD","originalCurrency":"USD","discount":{"couponId":"coupon_1","couponName":"Ten off","couponTerms":"10 USD off","promotionCode":"SAVE10","discountAmount":10,"originalDiscountAmount":10},"status":"success","paymentTime":1750148441000,"paymentMethod":{"paymentMethodType":"PAYPAL","paymentInstrumentId":"pi_xxxxx","wallet":{"accountTag":"s*****@personal.example.com"}},"metadata":{"orderNo":"ORDER-10002"}}}}},"failedCardPayment":{"title":"failedCardPayment","value":{"id":"event_xxxxx","object":"event","created":1750234841000,"type":"order.failed","data":{"object":{"orderId":"order_xxxxx","sessionId":"sess_xxxxx","type":"onetime","merchantReferenceId":"pay_ref_125","customerId":"cus_xxxxx","customerEmail":"customer@example.com","amountSubtotal":19.99,"amountTotal":9.99,"paymentCurrency":"USD","originalCurrency":"USD","discount":{"couponId":"coupon_1","couponName":"Ten off","couponTerms":"10 USD off","promotionCode":"SAVE10","discountAmount":10,"originalDiscountAmount":10},"status":"failed","paymentTime":1750234841000,"failureCode":"card_declined","failureMessage":"The card was declined","paymentMethod":{"paymentMethodType":"CARD","paymentInstrumentId":"pi_xxxxx","cardScheme":"Visa","cardLastFour":"4242","issuerRegion":"US","issuerBank":"Chase Bank"},"metadata":{"orderNo":"ORDER-10003"}}}}},"ucpOrderSucceeded":{"title":"ucpOrderSucceeded","value":{"id":"event_xxxxx","object":"event","created":1750321241000,"type":"order.succeeded","data":{"object":{"orderId":"order_xxxxx","sessionId":null,"type":"onetime","merchantReferenceId":"merchant_order_xxxxx","customerId":"cus_xxxxx","customerEmail":"customer@example.com","amountSubtotal":19.99,"amountTotal":9.99,"paymentCurrency":"USD","originalCurrency":"USD","discount":{"couponId":"coupon_1","couponName":"Ten off","couponTerms":"10 USD off","promotionCode":"SAVE10","discountAmount":10,"originalDiscountAmount":10},"status":"success","paymentTime":1750321241000,"paymentMethod":{"paymentMethodType":"CARD","paymentInstrumentId":"pi_xxxxx","cardScheme":"Visa","cardLastFour":"4242"},"metadata":{"checkoutId":"chk_xxxxx"}}}}},"ucpOrderFailed":{"title":"ucpOrderFailed","value":{"id":"event_xxxxx","object":"event","created":1750407641000,"type":"order.failed","data":{"object":{"orderId":"order_xxxxx","sessionId":null,"type":"onetime","merchantReferenceId":"merchant_order_xxxxx","customerId":"cus_xxxxx","customerEmail":"customer@example.com","amountSubtotal":19.99,"amountTotal":9.99,"paymentCurrency":"USD","originalCurrency":"USD","discount":{"couponId":"coupon_1","couponName":"Ten off","couponTerms":"10 USD off","promotionCode":"SAVE10","discountAmount":10,"originalDiscountAmount":10},"status":"failed","paymentTime":1750407641000,"failureCode":"card_declined","failureMessage":"The card was declined","paymentMethod":{"paymentMethodType":"CARD","paymentInstrumentId":"pi_xxxxx","cardScheme":"Visa","cardLastFour":"4242"},"metadata":{"checkoutId":"chk_xxxxx"}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"22acdbb9-18ad-40d6-8b50-ae104c4a664e":{"description":"Return a 200 status to indicate that the data was received successfully.\n\n### Account response\n\nOnly needed for orders that buy credits on your service, such as a top-up bought through a [Skill Marketplace](/guides/agent/skill_marketplace) Skill. When `order.succeeded` arrives for such an order, create or top up the user's account, then return the result in the response body.\n\n| `type` | Return it when |\n| :--- | :--- |\n| `account.created` | No account matched `data.object.customerEmail`. You created the account and applied the purchase as its first top-up. |\n| `account.reloaded` | An existing account matched `data.object.customerEmail`, and you applied the purchase to it. |\n\n```json\n{\n \"object\": \"event\",\n \"type\": \"account.created\",\n \"data\": {\n \"customerEmail\": \"customer@example.com\",\n \"webSite\": \"https://merchant.example.com\",\n \"userId\": \"usr_xxxxx\",\n \"amount\": 19.99,\n \"currency\": \"USD\"\n }\n}\n```\n\nAn `account.reloaded` response has the same shape.\n\n| Field | Requirement |\n| :--- | :--- |\n| `object` | Always `event`. |\n| `type` | `account.created` or `account.reloaded`. |\n| `data.customerEmail` | Must match `data.object.customerEmail` in the event. |\n| `data.webSite` | Your website's absolute URL, including `http://` or `https://`. |\n| `data.userId` | The user's ID in your system, not the Clink `customerId`. |\n| `data.amount` | Copy `data.object.amountTotal` from the event. |\n| `data.currency` | Copy `data.object.paymentCurrency` from the event. |\n\n- Commit the account change before you respond. A non-2xx status or a timeout makes Clink retry the event.\n- Deduplicate on the event `id`. For a repeated delivery, return the stored response without creating another account or applying the top-up again.\n- Clink uses this body only for orders paid through Agent Payment, and makes the result available to the buyer's agent. For other orders and other order events, an empty body is enough.\n\nFor the full processing sequence, see [Handle Skill payment webhooks](/guides/agent/skill_marketplace#handle-skill-payment-webhooks).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"7ce95461-a04d-43b4-a136-137963aec4b4":{"url":"https://uat-api.clinkbill.com/api/"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"clink","siteName":"Clink Documentation","title":"order - Clink Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/webhook/order","matchLevel":0},"cn":{"href":"/api-reference/webhook/order","matchLevel":0}}},"lastModified":"2026-10-10T08:15:42.646Z","originalFileLocation":"api-reference/webhook/order.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Handles order lifecycle events. For orders created through Universal Commerce Protocol (UCP), data.object.metadata.checkoutId identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, data.object.merchantReferenceId contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, merchantReferenceId is omitted from the UCP terminal event.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Clink Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"order - Clink Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Handles order lifecycle events. For orders created through Universal Commerce Protocol (UCP), data.object.metadata.checkoutId identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, data.object.merchantReferenceId contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, merchantReferenceId is omitted from the UCP terminal event.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Clink Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clinkbill.com/api-reference/webhook/order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clink.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=order\u0026amp;description=Handles+order+lifecycle+events.%0A%0AFor+orders+created+through+Universal+Commerce+Protocol+%28UCP%29%2C+%60data.object.metadata.checkoutId%60+identifies+the+originating+Chec\u0026amp;theme=be5a6376d6c12292dd7b4d25\u0026amp;signature=be4d2ebdf2e9d1c86c7ea98add29a200e4b4dd1b6d9fc99887994b488b85c2c9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"order - Clink Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Handles order lifecycle events. For orders created through Universal Commerce Protocol (UCP), data.object.metadata.checkoutId identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, data.object.merchantReferenceId contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, merchantReferenceId is omitted from the UCP terminal event.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clink.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=order\u0026amp;description=Handles+order+lifecycle+events.%0A%0AFor+orders+created+through+Universal+Commerce+Protocol+%28UCP%29%2C+%60data.object.metadata.checkoutId%60+identifies+the+originating+Chec\u0026amp;theme=be5a6376d6c12292dd7b4d25\u0026amp;signature=be4d2ebdf2e9d1c86c7ea98add29a200e4b4dd1b6d9fc99887994b488b85c2c9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Clink Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF9472\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clinkbill.com/api-reference/webhook/order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhook/order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clinkbill.com/#organization\",\"name\":\"Clink Documentation\",\"url\":\"https://docs.clinkbill.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clink/SmNnnZK50PsVdBCU/logo/light_new.svg?fit=max\u0026auto=format\u0026n=SmNnnZK50PsVdBCU\u0026q=85\u0026s=9956e279765b6e968dcc19748a3ee896\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clinkbill.com#website\",\"name\":\"Clink Documentation\",\"url\":\"https://docs.clinkbill.com\",\"publisher\":{\"@id\":\"https://docs.clinkbill.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clinkbill.com/api-reference/webhook/order#webpage\",\"url\":\"https://docs.clinkbill.com/api-reference/webhook/order\",\"name\":\"order\",\"description\":\"Handles order lifecycle events. For orders created through Universal Commerce Protocol (UCP), data.object.metadata.checkoutId identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, data.object.merchantReferenceId contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, merchantReferenceId is omitted from the UCP terminal event.\",\"dateModified\":\"2026-10-10T08:15:42.646Z\",\"isPartOf\":{\"@id\":\"https://docs.clinkbill.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clinkbill.com/api-reference/webhook/order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clinkbill.com/api-reference/webhook/order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Clink Documentation\",\"item\":\"https://docs.clinkbill.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"order\",\"item\":\"https://docs.clinkbill.com/api-reference/webhook/order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clinkbill.com/api-reference/webhook/order#apireference\",\"headline\":\"order\",\"name\":\"order\",\"description\":\"Handles order lifecycle events. For orders created through Universal Commerce Protocol (UCP), data.object.metadata.checkoutId identifies the originating Checkout throughout the order lifecycle. When OMS creates a third-party order through a connected merchant order channel and the merchant returns its order ID, data.object.merchantReferenceId contains that merchant-side order ID, not an OMS internal order ID. If no third-party merchant order was created, merchantReferenceId is omitted from the UCP terminal event.\",\"url\":\"https://docs.clinkbill.com/api-reference/webhook/order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clinkbill.com/api-reference/webhook/order#webpage\"},\"dateModified\":\"2026-10-10T08:15:42.646Z\",\"publisher\":{\"@id\":\"https://docs.clinkbill.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clinkbill.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Clink Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Clink Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/webhook/order.md","siteName":"Clink Documentation","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","icon":"chevrons-left-right-ellipsis","href":"/api-reference/introduction"},{"title":"TypeScript SDK","icon":"npm","href":"/api-reference/SDK"},{"title":"JavaScript SDK","icon":"code","href":"/api-reference/javascript_sdk"},{"title":"Clink CLI","icon":"terminal","href":"/api-reference/clink_cli"}]},{"group":"Clink MCP","pages":[{"title":"Wallet MCP tools","icon":"wallet","href":"/api-reference/mcp/wallet"},{"title":"Browser Pay tools","icon":"app-window","href":"/api-reference/mcp/browser_pay"},{"title":"Operations and recovery","icon":"refresh-cw","href":"/api-reference/mcp/operations"},{"title":"Catalog and UCP Checkout","icon":"shopping-cart","href":"/api-reference/mcp/commerce"},{"title":"Agent Platform MCP Login","icon":"key-round","href":"/api-reference/mcp/agent_platform_login"}]},{"group":"Agent Portal","icon":"layout-dashboard","pages":[{"title":"Agent Portal","sidebarTitle":"Agent Portal","icon":"layout-dashboard","href":"/api-reference/agent-portal/overview"},{"title":"Portal token","icon":"key-round","href":"/api-reference/agent-portal/portal_token"},{"title":"Portal APIs","icon":"database","href":"/api-reference/agent-portal/portal_apis"}]},{"group":"Checkout Session","pages":[{"title":"Create Checkout Session","openapi":"POST /checkout/session","href":"/api-reference/endpoint/create-checkout-session"},{"title":"Get Checkout Session","openapi":"GET /checkout/session/{id}","href":"/api-reference/endpoint/get-checkout-session"},{"title":"Expire Checkout Session","openapi":"POST /checkout/session/{id}/expire","href":"/api-reference/endpoint/expire-checkout-session"}]},{"group":"Payment","pages":[{"title":"Create Payment","openapi":"POST /payment","href":"/api-reference/endpoint/create-payment"},{"title":"Refresh Wallet QR Code","openapi":"POST /payment/{orderId}/qrcode/refresh","href":"/api-reference/endpoint/refresh-wallet-qrcode"}]},{"group":"Payment Instrument","pages":[{"title":"Create Payment Instrument","openapi":"POST /payment-instrument","href":"/api-reference/endpoint/create-payment-instrument"}]},{"group":"Order","pages":[{"title":"List Orders","openapi":"GET /order","href":"/api-reference/endpoint/list-orders"},{"title":"Get Order","openapi":"GET /order/{id}","href":"/api-reference/endpoint/get-order"}]},{"group":"Agent Payment Session","pages":[{"title":"Create Agent Payment Session","openapi":"POST /order/payment-session","href":"/api-reference/endpoint/create-agent-payment-session"},{"title":"Get Agent Payment Session","openapi":"GET /order/payment-session/{sessionId}","href":"/api-reference/endpoint/get-agent-payment-session"}]},{"group":"Refund","pages":[{"title":"Create Refund","openapi":"POST /refund","href":"/api-reference/endpoint/create-refund"},{"title":"Get Refund","openapi":"GET /refund/{id}","href":"/api-reference/endpoint/get-refund"}]},{"group":"Product","pages":[{"title":"Upload Product Image","openapi":"POST /product/image/upload","href":"/api-reference/endpoint/upload-product-image"},{"title":"Create Product","openapi":"POST /product","href":"/api-reference/endpoint/create-product"},{"title":"Get Product","openapi":"GET /product/{id}","href":"/api-reference/endpoint/get-product"},{"title":"Get Product List","openapi":"GET /product","href":"/api-reference/endpoint/get-product-list"}]},{"group":"Price","pages":[{"title":"Create Price","openapi":"POST /price","href":"/api-reference/endpoint/create-price"},{"title":"Get Price","openapi":"GET /price/{id}","href":"/api-reference/endpoint/get-price"},{"title":"Get Price List","openapi":"GET /price","href":"/api-reference/endpoint/get-price-list"},{"title":"Update Price","openapi":"PUT /price/{id}","href":"/api-reference/endpoint/update-price"}]},{"group":"Coupon","pages":[{"title":"Create Coupon","openapi":"POST /coupon","href":"/api-reference/endpoint/create-coupon"},{"title":"List Coupons","openapi":"GET /coupon","href":"/api-reference/endpoint/list-coupons"},{"title":"Get Coupon","openapi":"GET /coupon/{couponId}","href":"/api-reference/endpoint/get-coupon"},{"title":"Rename Coupon","openapi":"PUT /coupon/{couponId}/name","href":"/api-reference/endpoint/rename-coupon"}]},{"group":"Promotion Code","pages":[{"title":"Create Promotion Code","openapi":"POST /promotion-code/{id}","href":"/api-reference/endpoint/create-promotion-code"},{"title":"Get Promotion Code","openapi":"GET /promotion-code/{id}","href":"/api-reference/endpoint/get-promotion-code"},{"title":"List Promotion Codes by Coupon","openapi":"GET /promotion-code/coupon/{couponId}","href":"/api-reference/endpoint/list-promotion-codes-by-coupon"},{"title":"Activate Promotion Code","openapi":"PUT /promotion-code/{promotionCodeId}/active","href":"/api-reference/endpoint/activate-promotion-code"},{"title":"Deactivate Promotion Code","openapi":"PUT /promotion-code/{promotionCodeId}/deactivate","href":"/api-reference/endpoint/deactivate-promotion-code"}]},{"group":"Subscription","pages":[{"title":"Create Subscription","openapi":"POST /subscription","href":"/api-reference/endpoint/create-subscription"},{"title":"Get Subscription","openapi":"GET /subscription/{id}","href":"/api-reference/endpoint/get-subscription"},{"title":"Preview Subscription Update","openapi":"POST /subscription/{id}/update/preview","href":"/api-reference/endpoint/preview-subscription-update"},{"title":"Confirm Subscription Update","openapi":"POST /subscription/{id}/update/confirm","href":"/api-reference/endpoint/confirm-subscription-update"},{"title":"Cancel Subscription Update","openapi":"POST /subscription/{id}/update/cancel","href":"/api-reference/endpoint/cancel-subscription-update"},{"title":"Cancel Subscription","openapi":"POST /subscription/{id}/cancel","href":"/api-reference/endpoint/cancel-subscription"},{"title":"Get Invoice","openapi":"GET /subscription/invoice/{id}","href":"/api-reference/endpoint/get-invoice"}]},{"group":"Test Clock","pages":[{"title":"List Test Clocks","openapi":"GET /subscription/test-clocks/list","href":"/api-reference/endpoint/list-test-clocks"},{"title":"Create Test Clock","openapi":"POST /subscription/test-clocks","href":"/api-reference/endpoint/create-test-clock"},{"title":"Get Test Clock","openapi":"GET /subscription/test-clocks/{clockId}","href":"/api-reference/endpoint/get-test-clock"},{"title":"Advance Test Clock","openapi":"POST /subscription/test-clocks/{clockId}/advance","href":"/api-reference/endpoint/advance-test-clock"},{"title":"Complete Test Clock","openapi":"POST /subscription/test-clocks/{clockId}/complete","href":"/api-reference/endpoint/complete-test-clock"}]},{"group":"Customer Portal","pages":[{"title":"Customer Portal Session","openapi":"POST /billing/session","href":"/api-reference/endpoint/create-customer-portal"}]},{"group":"Webhook Endpoint Management","pages":[{"title":"List Webhook Events","openapi":"GET /webhook/events","href":"/api-reference/endpoint/list-webhook-events"},{"title":"List Webhook Endpoints","openapi":"GET /webhook/endpoints","href":"/api-reference/endpoint/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","openapi":"POST /webhook/endpoints","href":"/api-reference/endpoint/create-webhook-endpoint"},{"title":"Ensure Webhook Endpoint","openapi":"PUT /webhook/endpoints/ensure","href":"/api-reference/endpoint/ensure-webhook-endpoint"},{"title":"Get Webhook Endpoint","openapi":"GET /webhook/endpoints/{id}","href":"/api-reference/endpoint/get-webhook-endpoint"},{"title":"Update Webhook Endpoint","openapi":"PATCH /webhook/endpoints/{id}","href":"/api-reference/endpoint/update-webhook-endpoint"},{"title":"Enable Webhook Endpoint","openapi":"POST /webhook/endpoints/{id}/enable","href":"/api-reference/endpoint/enable-webhook-endpoint"},{"title":"Disable Webhook Endpoint","openapi":"POST /webhook/endpoints/{id}/disable","href":"/api-reference/endpoint/disable-webhook-endpoint"},{"title":"Rotate Webhook Signing Secret","openapi":"POST /webhook/endpoints/{id}/rotate-secret","href":"/api-reference/endpoint/rotate-webhook-signing-secret"},{"title":"Delete Webhook Endpoint","openapi":"DELETE /webhook/endpoints/{id}","description":"Delete a webhook endpoint. Deleted endpoints stop receiving webhook events.","href":"/api-reference/endpoint/delete-webhook-endpoint"}]},{"group":"Webhooks","pages":[{"title":"order","openapi":"WEBHOOK order","href":"/api-reference/webhook/order"},{"title":"refund","openapi":"WEBHOOK refund","description":"Webhook notification triggered when refund is created or updated","href":"/api-reference/webhook/refund"},{"title":"subscription","openapi":"WEBHOOK subscription","href":"/api-reference/webhook/subscription"},{"title":"invoice","openapi":"WEBHOOK invoice","href":"/api-reference/webhook/invoice"},{"title":"session","openapi":"WEBHOOK session","href":"/api-reference/webhook/session"},{"title":"customer.verify","openapi":"WEBHOOK customer.verify","href":"/api-reference/webhook/customer.verify"},{"title":"dispute","openapi":"WEBHOOK dispute","href":"/api-reference/webhook/dispute"}]}]}]},{"language":"cn","tabs":[{"tab":"知识库","pages":[{"title":"知识库","href":"/cn"}]},{"tab":"API 文档","groups":[{"group":"概述","pages":[{"title":"介绍","icon":"chevrons-left-right-ellipsis","href":"/cn/api-reference/introduction"},{"title":"TypeScript SDK","icon":"npm","href":"/cn/api-reference/SDK"},{"title":"JavaScript SDK","icon":"code","href":"/cn/api-reference/javascript_sdk"},{"title":"Clink CLI","icon":"terminal","href":"/cn/api-reference/clink_cli"}]},{"group":"Clink MCP","pages":[{"title":"Wallet MCP 工具","icon":"wallet","href":"/cn/api-reference/mcp/wallet"},{"title":"Browser Pay 工具","icon":"app-window","href":"/cn/api-reference/mcp/browser_pay"},{"title":"Operation 与恢复","icon":"refresh-cw","href":"/cn/api-reference/mcp/operations"},{"title":"Catalog 与 UCP Checkout","icon":"shopping-cart","href":"/cn/api-reference/mcp/commerce"},{"title":"Agent Platform MCP 登录","icon":"key-round","href":"/cn/api-reference/mcp/agent_platform_login"}]},{"group":"Agent Portal","icon":"layout-dashboard","pages":[{"title":"Agent Portal","sidebarTitle":"Agent Portal","icon":"layout-dashboard","href":"/cn/api-reference/agent-portal/overview"},{"title":"Portal token","icon":"key-round","href":"/cn/api-reference/agent-portal/portal_token"},{"title":"Portal 接口","icon":"database","href":"/cn/api-reference/agent-portal/portal_apis"}]},{"group":"Checkout Session","pages":[{"title":"Create Checkout Session","openapi":"POST /checkout/session","href":"/api-reference/endpoint/create-checkout-session"},{"title":"Get Checkout Session","openapi":"GET /checkout/session/{id}","href":"/api-reference/endpoint/get-checkout-session"},{"title":"Expire Checkout Session","openapi":"POST /checkout/session/{id}/expire","href":"/api-reference/endpoint/expire-checkout-session"}]},{"group":"Payment","pages":[{"title":"创建一次性支付","openapi":"POST /payment","href":"/cn/api-reference/endpoint/create-payment"},{"title":"刷新钱包二维码","openapi":"POST /payment/{orderId}/qrcode/refresh","href":"/cn/api-reference/endpoint/refresh-wallet-qrcode"}]},{"group":"Payment Instrument","pages":[{"title":"创建支付方式","openapi":"POST /payment-instrument","href":"/cn/api-reference/endpoint/create-payment-instrument"}]},{"group":"Order","pages":[{"title":"查询订单列表","openapi":"GET /order","href":"/cn/api-reference/endpoint/list-orders"},{"title":"Get Order","openapi":"GET /order/{id}","href":"/api-reference/endpoint/get-order"}]},{"group":"Agent Payment Session","pages":[{"title":"Create Agent Payment Session","openapi":"POST /order/payment-session","href":"/api-reference/endpoint/create-agent-payment-session"},{"title":"Get Agent Payment Session","openapi":"GET /order/payment-session/{sessionId}","href":"/api-reference/endpoint/get-agent-payment-session"}]},{"group":"Refund","pages":[{"title":"创建退款","openapi":"POST /refund","href":"/cn/api-reference/endpoint/create-refund"},{"title":"Get Refund","openapi":"GET /refund/{id}","href":"/api-reference/endpoint/get-refund"}]},{"group":"Product","pages":[{"title":"上传产品图片","openapi":"POST /product/image/upload","href":"/cn/api-reference/endpoint/upload-product-image"},{"title":"创建产品","openapi":"POST /product","href":"/cn/api-reference/endpoint/create-product"},{"title":"Get Product","openapi":"GET /product/{id}","href":"/api-reference/endpoint/get-product"},{"title":"Get Product List","openapi":"GET /product","href":"/api-reference/endpoint/get-product-list"}]},{"group":"Price","pages":[{"title":"创建价格","openapi":"POST /price","href":"/cn/api-reference/endpoint/create-price"},{"title":"Get Price","openapi":"GET /price/{id}","href":"/api-reference/endpoint/get-price"},{"title":"Get Price List","openapi":"GET /price","href":"/api-reference/endpoint/get-price-list"},{"title":"更新价格","openapi":"PUT /price/{id}","href":"/cn/api-reference/endpoint/update-price"}]},{"group":"Coupon","pages":[{"title":"创建优惠券","openapi":"POST /coupon","href":"/cn/api-reference/endpoint/create-coupon"},{"title":"查询优惠券列表","openapi":"GET /coupon","href":"/cn/api-reference/endpoint/list-coupons"},{"title":"查询优惠券","openapi":"GET /coupon/{couponId}","href":"/cn/api-reference/endpoint/get-coupon"},{"title":"重命名优惠券","openapi":"PUT /coupon/{couponId}/name","href":"/cn/api-reference/endpoint/rename-coupon"}]},{"group":"Promotion Code","pages":[{"title":"创建促销码","openapi":"POST /promotion-code/{id}","href":"/cn/api-reference/endpoint/create-promotion-code"},{"title":"查询促销码","openapi":"GET /promotion-code/{id}","href":"/cn/api-reference/endpoint/get-promotion-code"},{"title":"查询优惠券促销码列表","openapi":"GET /promotion-code/coupon/{couponId}","href":"/cn/api-reference/endpoint/list-promotion-codes-by-coupon"},{"title":"启用促销码","openapi":"PUT /promotion-code/{promotionCodeId}/active","href":"/cn/api-reference/endpoint/activate-promotion-code"},{"title":"停用促销码","openapi":"PUT /promotion-code/{promotionCodeId}/deactivate","href":"/cn/api-reference/endpoint/deactivate-promotion-code"}]},{"group":"Subscription","pages":[{"title":"创建订阅","openapi":"POST /subscription","href":"/cn/api-reference/endpoint/create-subscription"},{"title":"Get Subscription","openapi":"GET /subscription/{id}","href":"/api-reference/endpoint/get-subscription"},{"title":"预览订阅升降级","openapi":"POST /subscription/{id}/update/preview","href":"/cn/api-reference/endpoint/preview-subscription-update"},{"title":"确认订阅升降级","openapi":"POST /subscription/{id}/update/confirm","href":"/cn/api-reference/endpoint/confirm-subscription-update"},{"title":"取消待生效订阅变更","openapi":"POST /subscription/{id}/update/cancel","href":"/cn/api-reference/endpoint/cancel-subscription-update"},{"title":"Cancel Subscription","openapi":"POST /subscription/{id}/cancel","href":"/api-reference/endpoint/cancel-subscription"},{"title":"Get Invoice","openapi":"GET /subscription/invoice/{id}","href":"/api-reference/endpoint/get-invoice"}]},{"group":"Test Clock","pages":[{"title":"List Test Clocks","openapi":"GET /subscription/test-clocks/list","href":"/api-reference/endpoint/list-test-clocks"},{"title":"Create Test Clock","openapi":"POST /subscription/test-clocks","href":"/api-reference/endpoint/create-test-clock"},{"title":"Get Test Clock","openapi":"GET /subscription/test-clocks/{clockId}","href":"/api-reference/endpoint/get-test-clock"},{"title":"Advance Test Clock","openapi":"POST /subscription/test-clocks/{clockId}/advance","href":"/api-reference/endpoint/advance-test-clock"},{"title":"Complete Test Clock","openapi":"POST /subscription/test-clocks/{clockId}/complete","href":"/api-reference/endpoint/complete-test-clock"}]},{"group":"Customer Portal","pages":[{"title":"创建客户门户会话","openapi":"POST /billing/session","href":"/cn/api-reference/endpoint/create-customer-portal"}]},{"group":"Webhook Endpoint Management","pages":[{"title":"List Webhook Events","openapi":"GET /webhook/events","href":"/api-reference/endpoint/list-webhook-events"},{"title":"List Webhook Endpoints","openapi":"GET /webhook/endpoints","href":"/api-reference/endpoint/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","openapi":"POST /webhook/endpoints","href":"/api-reference/endpoint/create-webhook-endpoint"},{"title":"Ensure Webhook Endpoint","openapi":"PUT /webhook/endpoints/ensure","href":"/api-reference/endpoint/ensure-webhook-endpoint"},{"title":"Get Webhook Endpoint","openapi":"GET /webhook/endpoints/{id}","href":"/api-reference/endpoint/get-webhook-endpoint"},{"title":"Update Webhook Endpoint","openapi":"PATCH /webhook/endpoints/{id}","href":"/api-reference/endpoint/update-webhook-endpoint"},{"title":"Enable Webhook Endpoint","openapi":"POST /webhook/endpoints/{id}/enable","href":"/api-reference/endpoint/enable-webhook-endpoint"},{"title":"Disable Webhook Endpoint","openapi":"POST /webhook/endpoints/{id}/disable","href":"/api-reference/endpoint/disable-webhook-endpoint"},{"title":"Rotate Webhook Signing Secret","openapi":"POST /webhook/endpoints/{id}/rotate-secret","href":"/api-reference/endpoint/rotate-webhook-signing-secret"},{"title":"Delete Webhook Endpoint","openapi":"DELETE /webhook/endpoints/{id}","description":"Delete a webhook endpoint. Deleted endpoints stop receiving webhook events.","href":"/api-reference/endpoint/delete-webhook-endpoint"}]},{"group":"Webhooks","pages":[{"title":"order","openapi":"WEBHOOK order","href":"/api-reference/webhook/order"},{"title":"refund","openapi":"WEBHOOK refund","description":"Webhook notification triggered when refund is created or updated","href":"/api-reference/webhook/refund"},{"title":"subscription","openapi":"WEBHOOK subscription","href":"/api-reference/webhook/subscription"},{"title":"invoice","openapi":"WEBHOOK invoice","href":"/api-reference/webhook/invoice"},{"title":"session","openapi":"WEBHOOK session","href":"/api-reference/webhook/session"},{"title":"customer.verify","openapi":"WEBHOOK customer.verify","href":"/api-reference/webhook/customer.verify"},{"title":"dispute","openapi":"WEBHOOK dispute","href":"/api-reference/webhook/dispute"}]}]}]}]},"basePath":"","title":"order - Clink Documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}