GET
/
subscription
/
{id}
cURL
curl --request GET \
  --url https://api.clinkbill.dev/api/subscription/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "code": 200,
  "msg": "success",
  "data": {
    "merchantReference": "<string>",
    "subscriptionId": "<string>",
    "customerId": "<string>",
    "productId": "<string>",
    "priceId": "<string>",
    "priceSnapshotId": "<string>",
    "createTime": 1754819711382,
    "quantity": 1,
    "paymentMethodType": "CARD",
    "paymentInstrumentId": "<string>",
    "trialStart": 1754819707000,
    "trialEnd": 1755078907000,
    "currentPeriodStart": 1754819706689,
    "currentPeriodEnd": 1755078906689,
    "cancelAt": 123,
    "cancelAtPeriodEnd": true,
    "canceledAt": 123,
    "cancelReason": "<string>",
    "status": "incomplete",
    "billing": "charge_automatically",
    "currency": "USD",
    "recurringInvoiceItem": {
      "invoiceItemId": "<string>",
      "amount": 9.99,
      "currency": "USD",
      "description": "<string>",
      "periodStart": 1754819706689,
      "periodEnd": 1755078906689,
      "proration": true,
      "price": {
        "productId": "<string>",
        "productName": "<string>",
        "priceId": "<string>",
        "priceSnapshotId": "<string>",
        "unitAmount": 9.99,
        "quantity": 1,
        "recurring": {
          "interval": "week",
          "trialPeriodDays": 123,
          "pricingModel": "flat_rate",
          "tiersMode": "volume"
        }
      }
    },
    "upcomingInvoiceItem": {
      "invoiceItemId": "<string>",
      "amount": 9.99,
      "currency": "USD",
      "description": "<string>",
      "periodStart": 1754819706689,
      "periodEnd": 1755078906689,
      "proration": true,
      "price": {
        "productId": "<string>",
        "productName": "<string>",
        "priceId": "<string>",
        "priceSnapshotId": "<string>",
        "unitAmount": 9.99,
        "quantity": 1,
        "recurring": {
          "interval": "week",
          "trialPeriodDays": 123,
          "pricingModel": "flat_rate",
          "tiersMode": "volume"
        }
      }
    }
  }
}

Authorizations

X-API-KEY
string
header
required

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

X-Timestamp
string
header
required

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

Path Parameters

id
string
required

Unique identifier of the subscription

Response

200 - application/json

Subscription details retrieved successfully

The response is of type object.