rcp_cancel_member_payment_profile()

Cancel a member's payment profile. This will end their recurring subscription with the payment gateway.

Parameters:

  • $user_id - ID of the member to cancel.
  • $set_status (bool) (optional) - Whether or not to update the member's account status to 'canceled'. The default is true.

Return values:

  • true if the profile was successfully canceled.
  • false if the profile wasn't canceled, due to an error with the gateway or because the user isn't able to cancel their profile (see rcp_can_member_cancel()).
Powered by Zendesk