List Orders
curl --request GET \
--url https://uat-api.clinkbill.com/api/order \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>'HttpResponse<String> response = Unirest.get("https://uat-api.clinkbill.com/api/order")
.header("X-Timestamp", "<x-timestamp>")
.header("X-API-KEY", "<api-key>")
.asString();import requests
url = "https://uat-api.clinkbill.com/api/order"
headers = {
"X-Timestamp": "<x-timestamp>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Timestamp': '<x-timestamp>', 'X-API-KEY': '<api-key>'}
};
fetch('https://uat-api.clinkbill.com/api/order', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"total": 123,
"rows": [
{
"orderId": "<string>",
"type": "recurring",
"merchantReferenceId": "<string>",
"invoiceId": "<string>",
"customerId": "<string>",
"customerEmail": "<string>",
"productId": "<string>",
"priceId": "<string>",
"priceDataList": [
{
"name": "<string>",
"unitAmount": 1,
"quantity": 2,
"currency": "<string>",
"imageUrl": "<string>"
}
],
"paymentMethod": {
"paymentMethodType": "CARD",
"paymentInstrumentId": "<string>",
"cardScheme": "Visa",
"cardLastFour": "4242",
"issuerRegion": "US",
"issuerBank": "Chase Bank",
"wallet": {
"accountTag": "s*****@personal.example.com"
}
},
"paymentExecutionDetails": [
{
"channelCode": "<string>",
"channelTransactionId": "<string>",
"originalFailureCode": "<string>",
"originalFailureMessage": "<string>"
}
],
"amountSubtotal": 9.99,
"amountTotal": 9.99,
"discount": {
"couponId": "coupon_1",
"couponName": "Ten off",
"couponTerms": "10 USD off",
"promotionCode": "SAVE10",
"discountAmount": 10,
"originalDiscountAmount": 10
},
"paymentCurrency": "USD",
"originalCurrency": "USD",
"status": "success",
"failureCode": "card_declined",
"failureMessage": "The card was declined",
"paymentTime": 1754819711382,
"sessionId": "<string>",
"metadata": {
"checkoutId": "chk_xxxxx"
},
"riskLevel": "<string>"
}
],
"code": 200,
"msg": "success"
}"<string>"Order
查询订单列表
List orders under your current merchant account. You can filter orders by subscription ID, customer ID, or merchant reference ID.
GET
/
order
List Orders
curl --request GET \
--url https://uat-api.clinkbill.com/api/order \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>'HttpResponse<String> response = Unirest.get("https://uat-api.clinkbill.com/api/order")
.header("X-Timestamp", "<x-timestamp>")
.header("X-API-KEY", "<api-key>")
.asString();import requests
url = "https://uat-api.clinkbill.com/api/order"
headers = {
"X-Timestamp": "<x-timestamp>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Timestamp': '<x-timestamp>', 'X-API-KEY': '<api-key>'}
};
fetch('https://uat-api.clinkbill.com/api/order', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"total": 123,
"rows": [
{
"orderId": "<string>",
"type": "recurring",
"merchantReferenceId": "<string>",
"invoiceId": "<string>",
"customerId": "<string>",
"customerEmail": "<string>",
"productId": "<string>",
"priceId": "<string>",
"priceDataList": [
{
"name": "<string>",
"unitAmount": 1,
"quantity": 2,
"currency": "<string>",
"imageUrl": "<string>"
}
],
"paymentMethod": {
"paymentMethodType": "CARD",
"paymentInstrumentId": "<string>",
"cardScheme": "Visa",
"cardLastFour": "4242",
"issuerRegion": "US",
"issuerBank": "Chase Bank",
"wallet": {
"accountTag": "s*****@personal.example.com"
}
},
"paymentExecutionDetails": [
{
"channelCode": "<string>",
"channelTransactionId": "<string>",
"originalFailureCode": "<string>",
"originalFailureMessage": "<string>"
}
],
"amountSubtotal": 9.99,
"amountTotal": 9.99,
"discount": {
"couponId": "coupon_1",
"couponName": "Ten off",
"couponTerms": "10 USD off",
"promotionCode": "SAVE10",
"discountAmount": 10,
"originalDiscountAmount": 10
},
"paymentCurrency": "USD",
"originalCurrency": "USD",
"status": "success",
"failureCode": "card_declined",
"failureMessage": "The card was declined",
"paymentTime": 1754819711382,
"sessionId": "<string>",
"metadata": {
"checkoutId": "chk_xxxxx"
},
"riskLevel": "<string>"
}
],
"code": 200,
"msg": "success"
}"<string>"授权
Your secret API key obtained from the Clink dashboard (Developers section)
请求头
Current timestamp in milliseconds since Unix epoch (required for request signing)
示例:
"1783513683000"
查询参数
Subscription ID used to filter recurring orders
Customer ID used to filter orders
Merchant-side reference ID used to filter orders
Current page number. Defaults to 1.
Number of records per page. Defaults to 20. The maximum is 50; larger values are capped at 50.
必填范围:
x <= 50