curl --request POST \
--url https://uat-api.clinkbill.com/api/subscription/{id}/cancel \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"cancelReasonCode": "no_longer_needed",
"reason": "No longer needed",
"cancelImmediately": false
}
'{
"code": 123,
"msg": "<string>",
"data": {
"subscriptionId": "<string>",
"customerId": "<string>",
"productId": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"createTime": 123,
"quantity": 123,
"paymentMethodType": "<string>",
"paymentInstrumentId": "<string>",
"status": "<string>",
"billing": "<string>",
"recurringInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 123,
"discountAmount": 123,
"paymentAmount": 123,
"couponTerms": "<string>",
"promotionCode": "<string>",
"currency": "USD",
"periodStart": 123,
"periodEnd": 123,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 123,
"quantity": 123,
"recurring": {
"interval": "week",
"pricingModel": "flat_rate",
"trialPeriodDays": 123,
"tiersMode": "volume",
"intervalCount": 123
}
}
},
"merchantReference": "<string>",
"sessionId": "<string>",
"trialStart": 123,
"trialEnd": 123,
"currentPeriodStart": 123,
"currentPeriodEnd": 123,
"cancelAt": 123,
"cancelAtPeriodEnd": true,
"canceledAt": 123,
"cancelReason": "<string>",
"currency": "USD",
"upcomingInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 123,
"discountAmount": 123,
"paymentAmount": 123,
"couponTerms": "<string>",
"promotionCode": "<string>",
"currency": "USD",
"periodStart": 123,
"periodEnd": 123,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 123,
"quantity": 123,
"recurring": {
"interval": "week",
"pricingModel": "flat_rate",
"trialPeriodDays": 123,
"tiersMode": "volume",
"intervalCount": 123
}
}
},
"scheduledPhases": [
{
"sequence": 2,
"effectiveCycle": 2,
"priceSnapshotId": "<string>",
"quantity": 2,
"metadata": {}
}
],
"elapsedCycles": 123,
"metadata": {}
}
}"<string>"Subscription
Cancel Subscription
Cancel a subscription either immediately or at the end of the current billing period.
POST
/
subscription
/
{id}
/
cancel
curl --request POST \
--url https://uat-api.clinkbill.com/api/subscription/{id}/cancel \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"cancelReasonCode": "no_longer_needed",
"reason": "No longer needed",
"cancelImmediately": false
}
'{
"code": 123,
"msg": "<string>",
"data": {
"subscriptionId": "<string>",
"customerId": "<string>",
"productId": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"createTime": 123,
"quantity": 123,
"paymentMethodType": "<string>",
"paymentInstrumentId": "<string>",
"status": "<string>",
"billing": "<string>",
"recurringInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 123,
"discountAmount": 123,
"paymentAmount": 123,
"couponTerms": "<string>",
"promotionCode": "<string>",
"currency": "USD",
"periodStart": 123,
"periodEnd": 123,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 123,
"quantity": 123,
"recurring": {
"interval": "week",
"pricingModel": "flat_rate",
"trialPeriodDays": 123,
"tiersMode": "volume",
"intervalCount": 123
}
}
},
"merchantReference": "<string>",
"sessionId": "<string>",
"trialStart": 123,
"trialEnd": 123,
"currentPeriodStart": 123,
"currentPeriodEnd": 123,
"cancelAt": 123,
"cancelAtPeriodEnd": true,
"canceledAt": 123,
"cancelReason": "<string>",
"currency": "USD",
"upcomingInvoiceItem": {
"invoiceItemId": "<string>",
"amount": 123,
"discountAmount": 123,
"paymentAmount": 123,
"couponTerms": "<string>",
"promotionCode": "<string>",
"currency": "USD",
"periodStart": 123,
"periodEnd": 123,
"proration": true,
"price": {
"productId": "<string>",
"productName": "<string>",
"priceId": "<string>",
"priceSnapshotId": "<string>",
"unitAmount": 123,
"quantity": 123,
"recurring": {
"interval": "week",
"pricingModel": "flat_rate",
"trialPeriodDays": 123,
"tiersMode": "volume",
"intervalCount": 123
}
}
},
"scheduledPhases": [
{
"sequence": 2,
"effectiveCycle": 2,
"priceSnapshotId": "<string>",
"quantity": 2,
"metadata": {}
}
],
"elapsedCycles": 123,
"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
Body
application/json
Cancel subscription request
Required string length:
1 - 255Allowed cancel reason codes
Available options:
too_expensive, need_more_features, found_alternative, no_longer_needed, poor_customer_service, poor_usability, poor_quality, other_reasons Whether to cancel the subscription immediately. true cancels immediately without refund; false or omitted cancels at the end of the current billing period.