Skip to main content

​
Terminate an active subscription

Subscriptions in the incomplete state are held by an activation rule. They cancel on their own if the rule fails or its timeout is reached, and you can also cancel them on demand.
To terminate an active subscription through the user interface:
  1. Access the “Customers” section via the side menu;
  2. Select a customer from the list;
  3. In the “Overview” tab, select an active subscription; and
  4. Click “Terminate subscription”.

​
Generate a closing invoice at subscription termination

By default, Lago automatically generates a closing invoice for any outstanding usage-based charges or pay-in-arrears subscription fees that haven’t yet been invoiced. If you don’t want to generate an invoice at termination:
In the Termination dialog, switch off the Generate a final invoice on termination option.

​
Generate a closing credit note at subscription termination

If the subscription fee has been paid in advance, Lago automatically issues a credit note for the unused days. At termination, you can:
In the Termination dialog, the Credit note section asks how to handle the unused amount:
  • Offset invoice (offset) – The unused due amount is offset against the invoice, reducing the remaining amount due. The dialog shows this option only when the invoice still has an amount that can be offset.
  • Credit to wallet (credit) – The unused amount is credited back to the customer.
  • Refund the unused amount via a credit note (refund) – If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer. The dialog shows this option only when the invoice has a refundable amount.
  • Don’t create a credit note (skip) – No credit note is generated.
The dialog preselects the first option it shows: Offset invoice when the invoice can be offset, and Credit to wallet otherwise.
Termination dialog with the options for handling the unused amount.

Termination options

​
Terminate a pending subscription

To terminate a pending subscription through the user interface:
  1. Access the “Customers” section via the side menu;
  2. Select a customer from the list;
  3. In the “Overview” tab, select a pending subscription (subscription set in the future or pending downgrade); and
  4. Click “Terminate subscription” to cancel a pending subscription.
Include the ?status=pending filter. Without it, the endpoint targets the active subscription for that external_id and the pending one is not terminated.

​
Cancel an incomplete subscription

A subscription held incomplete by a payment activation rule (waiting for its first payment) can be canceled on demand, instead of waiting for the rule’s timeout. This is useful when the payment clearly won’t complete, for example when the customer abandons a 3D Secure challenge and you want to let them start over.
To cancel an incomplete subscription through the user interface:
  1. Access the “Customers” section via the side menu;
  2. Select a customer from the list;
  3. In the “Overview” tab, select the incomplete subscription; and
  4. Click “Cancel subscription”.
The subscription becomes canceled with cancellation_reason: manual. Its draft invoice is closed (nothing is billed), and any applied coupons, credit notes and wallet credits are recredited. Any pending payment is canceled with the payment provider on a best-effort basis: some payment statuses can’t be canceled, so a payment may still succeed later as a late payment. Termination options (on_termination_credit_note, on_termination_invoice) are ignored, since an incomplete subscription has never been billed.
Include the ?status=incomplete filter. Without it the endpoint targets the active subscription for that external_id and returns a not-found error for an incomplete one.