> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Manage a subscription

> Manage a subscription lifecycle, pause or cancel it

## Activate a pending subscription

If you want to activate a subscription from a `pending` status (e.g., if **manually**, **after checkout**, or **after quote signature** activation strategies were used during assignment), you can:

<Steps>
  <Step title="On the Subscriptions tab, click on Actions then Activate subscription">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/activate1.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=e6d3064487fb6b2ac732db8b936427b3" width="2574" height="1347" data-path="images/customers/activate1.png" />
    </Frame>
  </Step>

  <Step title="Click on Activate subscription to confirm">
    If the subscription's **start date is today or is already exceeded**, the subscription will switch to an active state (with a `Live` tag), and products that need to be billed at the start of the period will be charged immediately.

    If the **start date is in the future**, the subscription will switch to a `Starts on ...` state, signifying that the subscription is now active but hasn't started yet. The products will begin to be charged on the starting date.
  </Step>

  <Step title="The subscription status changed and now indicates `Live` or `Starts on ...`">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/activate3.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=3e0ab53fc8bd335396f67a5ce6535639" width="2580" height="1349" data-path="images/customers/activate3.png" />
    </Frame>
  </Step>
</Steps>

## Pause payment collection

You can pause a subscription if you want to stop payment collection without cancelling the subscription:

<Steps>
  <Step title="On the Subscriptions tab, click on Actions then Pause payment collection">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/pause1.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=eb257bfe34894e74bb2e3d9417641af4" width="2482" height="1424" data-path="images/customers/pause1.png" />
    </Frame>

    The subscription is not charged while paused. You can reactivate it anytime (instantly or later).
  </Step>

  <Step title="Click on Pause payment collection to confirm">
    <Frame>
      <img src="https://mintcdn.com/hyperline/ZWPni0Oh1Jb8sjUX/images/subscriptions/manage/pause-payment-collection.png?fit=max&auto=format&n=ZWPni0Oh1Jb8sjUX&q=85&s=a86e218e106bdf38a026c0546195a517" width="2370" height="1314" data-path="images/subscriptions/manage/pause-payment-collection.png" />
    </Frame>

    When pausing the payment collection, you can optionally select a date when the subscription will automatically restart.
  </Step>

  <Step title="The subscription status changed and now indicates Payment collection paused">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/pause3.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=43c362b9d01459afe9222f35ebe3cd6a" width="2480" height="1372" data-path="images/customers/pause3.png" />
    </Frame>
  </Step>
</Steps>

## Reactivate a paused subscription

Click on **Actions** then **Reactivate payment collection**. Upon reactivation, the customer **will not be billed** for any past period that was paused and is due.

## Cancel subscription

If a customer wishes to stop their subscription or if you need to make changes to their subscription that can't be done through the update subscription option, you can cancel the subscription.

<Steps>
  <Step title="On the subscription, click on Actions then Cancel subscription">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/cancel1.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=419e0e7c86a122f8230e9069f79b22ef" width="3360" height="1766" data-path="images/customers/cancel1.png" />
    </Frame>
  </Step>

  <Step title="Choose when you want to cancel your subscription">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/cancel-select-date.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=98fefec87924491e8b18c4a26ffd6485" width="872" height="844" data-path="images/customers/cancel-select-date.png" />
    </Frame>
  </Step>

  <Step title="Choose between the different methods">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/cancel-select-option.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=7b7042ef1142da97649bcd90a01634d1" width="952" height="811" data-path="images/customers/cancel-select-option.png" />
    </Frame>

    * **Refund last invoice:** Refunds the total of the last settled invoice to your customer, if available.
    * **Refund custom amount:** Displays a field for entering a custom refund amount to your customer.
    * **Refund pro rata:** Refunds a pro-rata amount based on customer usage so far, with a breakdown showing the products and respective balances.
    * **Do not refund:** Cancels the subscription without issuing a refund to your customer.

    <Note>
      When canceling a subscription before billing, for instance, the products within the subscription are billed at month-end ("end of period") and the cancellation is initiated mid-month you'll have the option to charge the customer instead. The selection choices will stay consistent, with the exception of the 'last invoice' option, which will be adjusted to reflect the estimated amount for the upcoming invoice.
    </Note>
  </Step>

  <Step title="Check that everything looks good before canceling">
    <Frame>
      <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/cancel-preview-step.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=ede8f043829b45cfc6f5ba832c4535b1" width="894" height="778" data-path="images/customers/cancel-preview-step.png" />
    </Frame>
  </Step>
</Steps>

<Note>
  A credit note will be issued and visible in the Invoices page of this
  customer. Its category will be `Refund` with an item "Refund for invoice X".

  <Frame>
    <img src="https://mintcdn.com/hyperline/64yOuGsnZeK6uIfv/images/customers/cancel4.png?fit=max&auto=format&n=64yOuGsnZeK6uIfv&q=85&s=880896ee91ebff456f8d7e80f46855f9" width="3356" height="1872" data-path="images/customers/cancel4.png" />
  </Frame>
</Note>

## Generate future invoices

Hyperline allows you to generate subscription invoices in advance. To do so, go to Subscription > Generate future invoices, then select the date up to which you want invoices to be issued. The subscription will be advanced to that date, and all corresponding invoices will be generated and sent immediately.

Depending on the payment method:

* Invoices will be **charged automatically** (credit card, direct debit)
* Invoices will be marked as **to pay** (bank transfers, outside of Hyperline)

  <Frame>
    <img src="https://mintcdn.com/hyperline/ZWPni0Oh1Jb8sjUX/images/subscriptions/manage/generate-future-invoices.png?fit=max&auto=format&n=ZWPni0Oh1Jb8sjUX&q=85&s=e27e4381ca831b1a0af20078cc02104f" width="1408" height="928" data-path="images/subscriptions/manage/generate-future-invoices.png" />
  </Frame>

## Viewing past subscription history

In order to provide enhanced transparency regarding subscription activities, you have now access to your past subscription history. This feature is particularly useful for tracking changes and cancellations of subscriptions that are no longer active.

Upon navigating to a customer's subscriptions page, you will find a section titled 'Past subscriptions'.

<Frame>
  <img src="https://mintcdn.com/hyperline/ZWPni0Oh1Jb8sjUX/images/subscriptions/history1.png?fit=max&auto=format&n=ZWPni0Oh1Jb8sjUX&q=85&s=9afcb71b673dd421936fbc3c8ae3c6ed" width="2480" height="1419" data-path="images/subscriptions/history1.png" />
</Frame>

Additionally, you can choose to archive a subscription by using the 'Delete subscription' action. The subscription will then no longer be displayed in the history list.

***

## Using the API

You can also decide to manage subscriptions using the Hyperline API. Visit our API reference documentation for more details.

* [Create subscription update endpoint](../../api-reference/endpoints/subscriptions/create-subscription-update)
* [Cancel subscription endpoint](../../api-reference/endpoints/subscriptions/cancel-subscription)
