Subscription: Cancel

If you want to stop billing a credit card, you can cancel the subscription.

  1. Ruby
result = gateway.subscription.cancel("the_subscription_id")

If the subscription can't be found, the API will return a Braintree::NotFoundError.


If you cancel a subscription, you won't be able to edit or reactivate it. You will need to create a new subscription instead.

subscription_idrequired, String

The value used to identify a specific subscription. If you do not specify an ID when creating a subscription, the gateway will generate a 6- or 7-character alphanumeric ID. Once canceled, a subscription can't be edited or reactivated. You must create a new subscription.

See also

See also the Subscription response object.