Function __global->make_cancel_button

Definitions

sources/ecommerce.php

  • Make a subscription cancellation button.This is for IPN-style transactions (as opposed to local transactions).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$purchase_id ID_TEXT No No required parameter N/A N/A The purchase ID
$payment_gateway ID_TEXT No No required parameter N/A N/A The payment gateway the payment will go via

Returns

  • The button (null: no special cancellation -- just delete the subscription row to stop the software regularly re-charging)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Make a subscription cancellation button.This is for IPN-style transactions (as opposed to local transactions).
 *
 * @param  ID_TEXT $purchase_id The purchase ID
 * @param  ID_TEXT $payment_gateway The payment gateway the payment will go via
 * @return ?Tempcode The button (null: no special cancellation -- just delete the subscription row to stop the software regularly re-charging)
 */
function make_cancel_button(string $purchase_id, string $payment_gateway) : ?object