Function Hook_payment_gateway_authorize->auto_cancel

Definitions

sources/hooks/systems/payment_gateway/authorize.php

  • Find whether the hook auto-cancels (if it does, auto cancel the given subscription).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$subscription_id AUTO_LINK No No required parameter N/A N/A ID of the subscription to cancel

Returns

  • True: yes. False: no. (null: cancels via a user-URL-directioning)
  • Type: ?boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether the hook auto-cancels (if it does, auto cancel the given subscription).
 *
 * @param  AUTO_LINK $subscription_id ID of the subscription to cancel
 * @return ?boolean True: yes. False: no. (null: cancels via a user-URL-directioning)
 */
public function auto_cancel(int $subscription_id) : ?bool