Method: ActiveMerchant::Billing::PaypalRecurringApi#suspend_recurring

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

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

Suspends a recurring payment profile.

Parameters

  • profile_id – A string containing the profile_id of the

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

[View source] [View on GitHub]

97
98
99
100
101
102
 
# File 'lib/active_merchant/billing/gateways/paypal/paypal_recurring_api.rb', line 97

def suspend_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, 'Suspend', options)
end