Recharge Cancel Subscription

Cancels a Recharge subscription by its ID, recording a cancellation reason. Use it in subscription cancellation flows when a customer asks to stop a subscription.

What it does

  • Cancels the Recharge subscription that matches the given subscription ID.
  • Stores the cancellation reason against the subscription.
  • Optionally suppresses the cancellation email to the customer and store owner.
  • Reports whether the cancellation succeeded through the Success flag.

Inputs

NameTypeDescription
Recharge Access TokenString (sensitive)Recharge API Access Token
Subscription IDStringRecharge Subscription ID to be cancelled
Cancellation ReasonStringReason for subscription cancellation
Send EmailBooleanIf set to false, subscription cancelled email will not be sent to customer and store owner.

Outputs

NameTypeDescription
SuccessBooleanSuccess

Notes

  • Set Send Email to false to cancel without notifying the customer and store owner; leave it true to send the standard cancellation email.
  • Cancellation is by subscription ID, so make sure you have the correct subscription before cancelling.

API reference