Method: ActiveMerchant::Billing::PaypalRecurringApi#cancel_recurring

Defined in:
lib/active_merchant/billing/gateways/paypal/paypal_recurring_api.rb

#cancel_recurring(profile_id, options = {}) ⇒ Object

Cancel a recurring payment.

This transaction cancels an existing recurring billing profile. Your account must have recurring billing enabled and the subscription must have already been created previously by calling recurring()

Parameters

  • profile_id – A string containing the profile_id of the

recurring payment already in place for a given credit card. (REQUIRED)

  • options – A hash with extra info (‘note’ for ex.)

[View source] [View on GitHub]

71
72
73
74
75
76
 
# File 'lib/active_merchant/billing/gateways/paypal/paypal_recurring_api.rb', line 71

def cancel_recurring(profile_id, options = {})
  ActiveMerchant.deprecated Gateway::RECURRING_DEPRECATION_MESSAGE

  raise_error_if_blank('profile_id', profile_id)
  commit 'ManageRecurringPaymentsProfileStatus', build_manage_profile_request(profile_id, 'Cancel', options)
end