cURL
curl --request GET \
--url https://uat-api.clinkbill.com/api/subscription/{id} \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>'HttpResponse<String> response = Unirest.get("https://uat-api.clinkbill.com/api/subscription/{id}")
.header("X-Timestamp", "<x-timestamp>")
.header("X-API-KEY", "<api-key>")
.asString();import requests
url = "https://uat-api.clinkbill.com/api/subscription/{id}"
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/subscription/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"code": 200,
"msg": "success",
"data": {
"subscriptionId": "<string>",
"customerId": "<string>",
"productId": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"createTime": 1754819711382,
"quantity": 1,
"paymentMethodType": "CARD",
"paymentInstrumentId": "<string>",
"merchantReference": "<string>",
"trialStart": 1754819707000,
"trialEnd": 1755078907000,
"currentPeriodStart": 1754819706689,
"currentPeriodEnd": 1755078906689,
"cancelAt": 123,
"cancelAtPeriodEnd": true,
"canceledAt": 123,
"cancelReason": "<string>",
"recurringInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 9.99,
"description": "<string>",
"periodStart": 1754819706689,
"periodEnd": 1755078906689,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 9.99,
"quantity": 1,
"recurring": {
"trialPeriodDays": 123,
"intervalCount": 123
}
}
},
"upcomingInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 9.99,
"description": "<string>",
"periodStart": 1754819706689,
"periodEnd": 1755078906689,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 9.99,
"quantity": 1,
"recurring": {
"trialPeriodDays": 123,
"intervalCount": 123
}
}
},
"scheduledPhases": [
{
"sequence": 2,
"effectiveCycle": 2,
"priceSnapshotId": "<string>",
"quantity": 2,
"metadata": {}
}
],
"elapsedCycles": 123,
"sessionId": "<string>",
"metadata": {}
}
}"<string>"Subscription
Get Subscription
Get detailed information about a specific subscription
GET
/
subscription
/
{id}
cURL
curl --request GET \
--url https://uat-api.clinkbill.com/api/subscription/{id} \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>'HttpResponse<String> response = Unirest.get("https://uat-api.clinkbill.com/api/subscription/{id}")
.header("X-Timestamp", "<x-timestamp>")
.header("X-API-KEY", "<api-key>")
.asString();import requests
url = "https://uat-api.clinkbill.com/api/subscription/{id}"
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/subscription/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"code": 200,
"msg": "success",
"data": {
"subscriptionId": "<string>",
"customerId": "<string>",
"productId": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"createTime": 1754819711382,
"quantity": 1,
"paymentMethodType": "CARD",
"paymentInstrumentId": "<string>",
"merchantReference": "<string>",
"trialStart": 1754819707000,
"trialEnd": 1755078907000,
"currentPeriodStart": 1754819706689,
"currentPeriodEnd": 1755078906689,
"cancelAt": 123,
"cancelAtPeriodEnd": true,
"canceledAt": 123,
"cancelReason": "<string>",
"recurringInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 9.99,
"description": "<string>",
"periodStart": 1754819706689,
"periodEnd": 1755078906689,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 9.99,
"quantity": 1,
"recurring": {
"trialPeriodDays": 123,
"intervalCount": 123
}
}
},
"upcomingInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 9.99,
"description": "<string>",
"periodStart": 1754819706689,
"periodEnd": 1755078906689,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 9.99,
"quantity": 1,
"recurring": {
"trialPeriodDays": 123,
"intervalCount": 123
}
}
},
"scheduledPhases": [
{
"sequence": 2,
"effectiveCycle": 2,
"priceSnapshotId": "<string>",
"quantity": 2,
"metadata": {}
}
],
"elapsedCycles": 123,
"sessionId": "<string>",
"metadata": {}
}
}"<string>"Authorizations
Your secret API key obtained from the Clink dashboard (Developers section)
Headers
Current timestamp in milliseconds since Unix epoch (required for request signing)
Example:
"1783513683000"
Path Parameters
Unique identifier of the subscription
⌘I