Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
External ID of the existing subscription
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Query Parameters
If the field is not defined, Lago will terminate only active
subscriptions. However, if you wish to cancel a pending
subscription, please ensure that you include status=pending
in your request.
"pending"
When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default. This field allows you to control the behavior of the credit note generation:
credit
: A credit note is generated for the unused subscription time. The unused amount is credited back to the customer.refund
: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer.skip
: No credit note is generated for the unused subscription time.
Note: This field is only applicable to pay-in-advance plans and is ignored for pay-in-arrears plans.
credit
, refund
, skip
"credit"
When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage. This field allows you to control the behavior of the invoice generation:
generate
: An invoice is generated for the unbilled usage.skip
: No invoice is generated for the unbilled usage.
generate
, skip
"generate"
Response
Subscription terminated
The response is of type object
.