Deletes a specified subscription.
This operation schedules the subscription resource for deletion, and it is permanently deleted after a few minutes. If you wish to retain the subscription data but stop further renewals, consider canceling or pausing the subscription instead.
Prerequisites & Constraints
- There must not be any invoices belonging to this subscription that have allocations from credit notes not belonging to this subscription.
- There must not be any credit notes belonging to this subscription that have been allocated to invoices not belonging to this subscription.
- There should not be any consolidated invoices for the customer with lines belonging to this subscription.
Impacts
Invoices
- All the invoices belonging to the subscription are deleted.
- See Delete an invoice API for more details on the impacts of deleting an invoice.
Credit notes
All the credit notes belonging to this subscription are deleted.
Transactions
All the transactions belonging to this subscription are deleted.
Usages
All usages belonging to this subscription are deleted.
Usage events
Deleting a subscription does not delete the associated usage events.
Reporting
The numbers in the following reports are modified when a subscription is deleted: Payments, New Revenue, Signups, Activations, Cancellations, and Refunds.
Integrations
Deleting a subscription may affect any third-party integrations you may have with Chargebee Billing. Review all integrations to assess the impact before proceeding.
Implementation Notes
Before deleting a subscription, ensure the following:
- Retrieve all the invoices for this subscription using the List invoices API. For each invoice, look up all the applied credit notes (
credit_note.applied_credits.cn_id). For all such credit notes, check if the associated subscription (credit_note.subscription_id) is this subscription. If not, use the Remove credit note from an invoice API to remove the credit note allocation. - Retrieve all the credit notes for this subscription using the List credit notes API. For each credit note, look up all the invoice allocations (
credit_note.allocations.invoice_id). For all such invoices, check if the associated subscription (invoice.subscription_id) is this subscription. If not, use the Remove credit note from an invoice API to remove the allocation. - Delete any consolidated invoices containing lines belonging to this subscription.