gform_post_subscription_started

Description

The “gform_post_subscription_started” action in Gravity Forms is triggered after a new subscription is created, allowing further actions to be taken.

Usage

add_action( &#039;gform_post_subscription_started&#039;, &#039;my_function&#039;, 10, 2 );

Parameters

$entry Entry Object
The entry object.
$subscription array

$action = array(
&#039;type&#039;             =&gt; &#039;&#039;,
&#039;amount&#039;           =&gt; &#039;&#039;,
&#039;transaction_type&#039; =&gt; &#039;&#039;,
&#039;transaction_id&#039;   =&gt; &#039;&#039;,
&#039;subscription_id&#039;  =&gt; &#039;&#039;,
&#039;entry_id&#039;         =&gt; &#039;&#039;,
&#039;payment_status&#039;   =&gt; &#039;&#039;,
&#039;note&#039;             =&gt; &#039;&#039;,
);

Examples

function my_function() {

    // Do something here.

    // If data from the Stripe webhook event is needed (and this hook was initiated via a Stripe webhook request), you can access event data with the following line:
    $event = gf_stripe()-&gt;get_webhook_event();
    if ( $event ){
       // Access webhook event data. For event object documentation, see: https://stripe.com/docs/api/events/object
}
add_action( &#039;gform_post_subscription_started&#039;, &#039;my_function&#039;, 10, 2 );

Source Code

do_action( &#039;gform_post_subscription_started&#039;, $entry, $subscription );

This action hook is located in GFPaymentAddOn::start_subscription() in includes/addon/class-gf-payment-addon.php.