​
Overview

A subscription is an agreement where a customer pays a recurring fee (e.g., weekly, monthly, annually) to access a product, service, or content. Key characteristics of subscriptions include:
  • Recurring Payments: Customers are billed regularly.
  • Continuous Access: Subscribers receive ongoing access to the product or service as long as payments are made.
  • Flexibility: Subscriptions may offer options to upgrade, downgrade, or cancel at any time, depending on the provider’s terms.

​
Subscription Data

​
Status

  • Incomplete: The subscription was created, but the checkout session was not paid successfully.
  • Incomplete Expired: The subscription is incomplete and has been closed because the checkout session expired.
  • Active: The subscription is active with no outstanding bills.
  • Trialing: The subscription is in a free trial period. No payments have been attempted yet, but the customer has provided payment information.
  • Past Due: Payment attempts for renewal have failed, but the subscription remains active and will retry.
  • Canceled: The subscription has been terminated.

​
Product & Price

The product represents the service that customer and merchant have agreed upon. The price contains information about the billing cycle and the payment amount to maintain the agreement.

​
Customer

A subscription contains a customer ID, representing the real-world client who agrees to pay periodically for the merchant service. The customer owns the payment instrument used for recurring payments. If a customer deletes the payment instrument associated with the subscription but has other payment instruments available, Clink will use the default payment instrument for renewal.

​
Subscription Management

​
Listing and Querying

Subscriptions can be viewed under the Subscriptions tab. By default, subscriptions are listed chronologically based on their creation time. You can filter subscriptions using the following criteria:
  • Amount: The monetary value of the product
  • Currency: The currency used in the agreement
  • Customer ID: The customer ID associated with the subscription
  • Created Date: The time period when subscriptions were created
  • Status: The current subscription status

​
Subscription Detail

Clicking on any subscription from the list will display its detailed information, including:
  • Product & Price
  • Customer and the payment instrument
  • Invoices and the billing cycle coverage

​
Cancel a Subscription

To cancel a subscription:
  1. Go to the Subscriptions tab
  2. Locate the subscription using the search function and open the details page
  3. Click on the Action button on the top right
  4. Select Cancel subscription from the dropdown list
  5. Select the reason for cancellation in the popup window
  6. Click the OK button

​
Downgrade or Upgrade a Subscription

We do not support merchants downgrading or upgrading subscriptions on customers’ behalf. To complete such requests, please guide customers to the customer portal for self-service.
Refund: Canceling a subscription will not issue a prorated refund automatically.
For example, if your service is usage-based metering, you will need to calculate the refund amount. If a refund is required upon cancellation, please submit a refund request.

​
Invoice

An invoice is generated on every billing cycle for the subscription. Customers can download invoices for expense purposes, proof of payments, etc.

​
Status

  • Open: The initial status of an invoice, indicating it is waiting for payment.
  • Paid: The bill amount has been received.
  • Void: The invoice is closed but unpaid.

​
Invoice Management

Invoices are generated automatically when the service is initially subscribed to or when renewal is triggered. We do not currently support manual invoice creation. Invoices are strongly tied to subscriptions. To view the list of invoices, navigate to the subscription details page and scroll down.