Cancel Subscription

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>",
      "periodStart": 123,
      "periodEnd": 123,
      "proration": true,
      "price": {
        "productId": "<string>",
        "productName": "<string>",
        "priceId": "<string>",
        "priceSnapshotId": "<string>",
        "unitAmount": 123,
        "quantity": 123,
        "recurring": {
          "trialPeriodDays": 123,
          "intervalCount": 123
        }
      }
    },
    "merchantReference": "<string>",
    "sessionId": "<string>",
    "trialStart": 123,
    "trialEnd": 123,
    "currentPeriodStart": 123,
    "currentPeriodEnd": 123,
    "cancelAt": 123,
    "cancelAtPeriodEnd": true,
    "canceledAt": 123,
    "cancelReason": "<string>",
    "upcomingInvoiceItem": {
      "invoiceItemId": "<string>",
      "amount": 123,
      "discountAmount": 123,
      "paymentAmount": 123,
      "couponTerms": "<string>",
      "promotionCode": "<string>",
      "periodStart": 123,
      "periodEnd": 123,
      "proration": true,
      "price": {
        "productId": "<string>",
        "productName": "<string>",
        "priceId": "<string>",
        "priceSnapshotId": "<string>",
        "unitAmount": 123,
        "quantity": 123,
        "recurring": {
          "trialPeriodDays": 123,
          "intervalCount": 123
        }
      }
    },
    "scheduledPhases": [
      {
        "sequence": 2,
        "effectiveCycle": 2,
        "priceSnapshotId": "<string>",
        "quantity": 2,
        "metadata": {}
      }
    ],
    "elapsedCycles": 123,
    "metadata": {}
  }
}

"<string>"

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>",
      "periodStart": 123,
      "periodEnd": 123,
      "proration": true,
      "price": {
        "productId": "<string>",
        "productName": "<string>",
        "priceId": "<string>",
        "priceSnapshotId": "<string>",
        "unitAmount": 123,
        "quantity": 123,
        "recurring": {
          "trialPeriodDays": 123,
          "intervalCount": 123
        }
      }
    },
    "merchantReference": "<string>",
    "sessionId": "<string>",
    "trialStart": 123,
    "trialEnd": 123,
    "currentPeriodStart": 123,
    "currentPeriodEnd": 123,
    "cancelAt": 123,
    "cancelAtPeriodEnd": true,
    "canceledAt": 123,
    "cancelReason": "<string>",
    "upcomingInvoiceItem": {
      "invoiceItemId": "<string>",
      "amount": 123,
      "discountAmount": 123,
      "paymentAmount": 123,
      "couponTerms": "<string>",
      "promotionCode": "<string>",
      "periodStart": 123,
      "periodEnd": 123,
      "proration": true,
      "price": {
        "productId": "<string>",
        "productName": "<string>",
        "priceId": "<string>",
        "priceSnapshotId": "<string>",
        "unitAmount": 123,
        "quantity": 123,
        "recurring": {
          "trialPeriodDays": 123,
          "intervalCount": 123
        }
      }
    },
    "scheduledPhases": [
      {
        "sequence": 2,
        "effectiveCycle": 2,
        "priceSnapshotId": "<string>",
        "quantity": 2,
        "metadata": {}
      }
    ],
    "elapsedCycles": 123,
    "metadata": {}
  }
}

"<string>"

Authorizations

X-API-KEY

string

header

required

Your secret API key obtained from the Clink dashboard (Developers section)

Headers

X-Timestamp

string

required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Example:

"1783513683000"

Path Parameters

string

required

Unique identifier of the subscription

Body

application/json

Cancel subscription request

reason

string

required

Required string length: 1 - 255

cancelReasonCode

enum<string>

Allowed cancel reason codes

Available options:

too_expensive,

need_more_features,

found_alternative,

no_longer_needed,

poor_customer_service,

poor_usability,

poor_quality,

other_reasons

cancelImmediately

boolean

default:false

Whether to cancel the subscription immediately. true cancels immediately without refund; false or omitted cancels at the end of the current billing period.

Response

updated subscription

code

integer<int32>

msg

string

data

object

Show child attributes

Cancel Subscription Update List test clocks

API Documentation

Checkout Session

Payment

Payment Instrument

Order

Agent Payment Session

Refund

Product

Price

Coupon

Promotion Code

Subscription

Test Clock

Customer Portal

Webhook Endpoint Management

Webhooks

API Reference

Subscription API

Test Clock

Agent Payment Session

Authorizations

Headers

Path Parameters

Body

Response