Documentation Index
Fetch the complete documentation index at: https://docs.metrifox.com/llms.txt
Use this file to discover all available pages before exploring further.
By default the cancellation is scheduled for the end of the current billing cycle. The subscription stays active until its renewal date (
ends_at) and then transitions to canceled — the customer keeps access to what they have already paid for, and no further invoices are generated.Pass
immediate: true to cancel right away. The subscription is set to canceled immediately and cancelled_at is populated. Free-plan and in-trial subscriptions are always cancelled immediately, regardless of the immediate flag, since there is no paid period to honour.The success
message reflects what happened: "Cancellation scheduled successfully. Ends at ..." when scheduled, or "Subscription canceled successfully" when cancelled immediately.Changed your mind? Use
POST /api/v1/subscriptions/{subscription_id}/revert-cancellation to undo a scheduled cancellation before its ends_at date is reached.