Expire subscription

Expire the subscription instantly. The operation will fail if the subscription has pending or dunning invoices. Handle these separately, e.g. by cancelling all dunning and pending. Expire can be given an optional argument describing how to compensate for the current period if already paid for with settled invoice.

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code HTTP codeDescription
12404Subscription not found
13400Subscription already expired
63400Subscription has pending or dunning invoices, these needs to be handled first
64400Refund compensation is used but the current billing period invoice is not in required state settled
65400Refund compensation is used but the refund amount exceeds the refundable amount on the current billing period invoice. The refundable amount is the setlled invoice amount minus already refunded and credited amounts.
81400Refund compensation is not allowed for asynchronous refund payment method
66500The refund compensation failed because of error at the acquirer. See transaction_error See transaction errors.
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!