WooCommerce: Stripe product and customer metadata

woocommerce-stripe-product-customer-metadata

/**
 * Add Stripe metadata along with WooCommerce purchase
 *
 * @param $metadata
 * @param $order
 * @param $source
 * @return mixed
 */
function wbdc_filter_wc_stripe_payment_metadata( $metadata, $order, $source ) {

    /**
     * Get order data
     */
    $order_data = $order->get_data();
    $metadata[ __( 'Billing Company', 'woocommerce-gateway-stripe' ) ] = sanitize_text_field( $order_data['billing']['company'] );
    $metadata[ __( 'Customer Name', 'woocommerce-gateway-stripe' ) ] = sanitize_text_field( $order_data['billing']['first_name'] . ' ' . $order_data['billing']['last_name'] );
    $metadata[ __( 'Customer Phone', 'woocommerce-gateway-stripe' ) ] = sanitize_text_field( $order_data['billing']['phone'] );

    /**
     * List products purchased
     */
    $count = 1;
    foreach( $order->get_items() as $item_id => $line_item ){
        $item_data = $line_item->get_data();
        $product = $line_item->get_product();
        $product_name = $product->get_name();
        $item_quantity = $line_item->get_quantity();
        $item_total = $line_item->get_total();
        $metadata['Line Item '.$count] = 'Product name: '.$product_name.' | Quantity: '.$item_quantity.' | Item total: '. number_format( $item_total, 2 );
        $count += 1;
    }

    return $metadata;
}
add_filter( 'wc_stripe_payment_metadata', 'wbdc_filter_wc_stripe_payment_metadata', 10, 3 );

You're welcome. Glad it was useful. Wil.

…

On Sat, 30 Oct 2021, 3:53 am harryfine, ***@***.***> wrote: ***@***.**** commented on this gist. ------------------------------ You are an ace. I was having trouble getting the metadata of product code back after making a sale from Woocommerce. This code worked perfectly. I appreciate the time you took writing this and thank you for providing it for free. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://gist.github.com/0decf69258a03d6a18eea8e8a6eac252#gistcomment-3944774>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABZONGY75N622PWIBUL4OXTUJLGQXANCNFSM5G7X4U7Q> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

Thank you - helped me access the metadata and pass it to Stripe!

how do I add product name to the metadata? I'm able to write out a line: $metadata[ __( 'Event Title', 'woocommerce-gateway-stripe' ) ] = sanitize_text_field( $event_title['Event Name:']);
and am using $product = $product->get_product();
$event_title= $product->get_name();
Then i added $product to the parameters of the function and made it 10,4 for the filter. I'm new to this so I'm trying to piece it all together correctly. what am I doing wrong?

how do I add product name to the metadata? I'm able to write out a line: $metadata[ __( 'Event Title', 'woocommerce-gateway-stripe' ) ] = sanitize_text_field( $event_title['Event Name:']); and am using $product = $product->get_product(); $event_title= $product->get_name(); Then i added $product to the parameters of the function and made it 10,4 for the filter. I'm new to this so I'm trying to piece it all together correctly. what am I doing wrong?

If you want to add the product name as Stripe meta then add these two lines after Line 17 in my code above:

$product = $product->get_product();
$event_title = $product->get_name();
$metadata[  __( 'Event Title', 'woocommerce-gateway-stripe' )  ] = 'Event Title: ' . sanitize_text_field( $event_title );

Thanks so much for the code. I’ve added it but when I try to test a transaction I get an "error processing checkout”. When I run your original code it completes a transaction successfully. When I try to get the product name as part of the metadata with the added code below I get the error message. I know it’s not the web hook or api key with stripe because the original code works. When I try to use var_dump($product) it doesn’t show me anything on the screen. Not sure if that’s a Wordpress thing or php. Do I have to add $product to the parameters of the function? Any other ideas to troubleshoot? I really really appreciate the reply before. I know you’re probably busy but any ideas would be greatly appreciated. I’ll continue to grind on it. Thank you for your content! Darlene Kartali

…

On Nov 14, 2023, at 7:55 PM, Wil Brown ***@***.***> wrote: @DeveloperWil commented on this gist. how do I add product name to the metadata? I'm able to write out a line: $metadata[ __( 'Event Title', 'woocommerce-gateway-stripe' ) ] = sanitize_text_field( $event_title['Event Name:']); and am using $product = $product->get_product(); $event_title= $product->get_name(); Then i added $product to the parameters of the function and made it 10,4 for the filter. I'm new to this so I'm trying to piece it all together correctly. what am I doing wrong? If you want to add the product name as Stripe meta then add these two lines after Line 17 in my code above: $product = $product->get_product(); $event_title= $product->get_name(); $metadata[ __( 'Event Title', 'woocommerce-gateway-stripe' ) ] = "Event Title: ' . sanitize_text_field( $event_title); — Reply to this email directly, view it on GitHub <https://gist.github.com/DeveloperWil/0decf69258a03d6a18eea8e8a6eac252#gistcomment-4760960> or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2NWZGJYNDOLP4R26Z7EI23YEQOIDBFKMF2HI4TJMJ2XIZLTSKBKK5TBNR2WLJDHNFZXJJDOMFWWLK3UNBZGKYLEL52HS4DFQKSXMYLMOVS2I5DSOVS2I3TBNVS3W5DIOJSWCZC7OBQXE5DJMNUXAYLOORPWCY3UNF3GS5DZVRZXKYTKMVRXIX3UPFYGLK2HNFZXIQ3PNVWWK3TUUZ2G64DJMNZZDAVEOR4XAZNEM5UXG5FFOZQWY5LFVEYTAOBXGQ2TIMRWU52HE2LHM5SXFJTDOJSWC5DF>. You are receiving this email because you commented on the thread. Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

@MuggleWizard Okies, sorry - that was my bad.
You need to get the line items from the $order variable, even if there's only one item.

So, you can change line 29 of the original code to:
$metadata['Event Item '.$count] = 'Event name: '.$product_name.' | Quantity: '.$item_quantity.' | Item total: '. number_format( $item_total, 2 );

So you'll end up the "Event Item 1" as the stripe meta field.

You could do some extra processing beforehand to see if there is only one line item like:

$items = $order->get_items();
if ( count( $items ) === 1 ){
  $product = $line_item[0]->get_product();
  $event_title = $product->get_name();
  $metadata[  __( 'Event Title', 'woocommerce-gateway-stripe' )  ] = 'Event Title: ' . sanitize_text_field( $event_title );
} else {
  //do the line item iteration
}

You should probably do some testing about the product type and name before you run this code if you ever plan to offer products other than the event ticket,

Hop that helps.

Thanks so much for the explanation. I appreciate your time with this. It works perfectly when I add it to the original code.

…

On Nov 15, 2023, at 6:40 PM, Wil Brown ***@***.***> wrote: @DeveloperWil commented on this gist. @MuggleWizard <https://github.com/MuggleWizard> Okies, sorry - that was my bad. You need to get the line items from the $order variable, even if there's only one item. So, you can change line 29 of the original code to: $metadata['Event Item '.$count] = 'Event name: '.$product_name.' | Quantity: '.$item_quantity.' | Item total: '. number_format( $item_total, 2 ); So you'll end up the "Event Item 1" as the stripe meta field. You could do some extra processing beforehand to see if there is only one line item like: $items = $order->get_items(); if ( count( $items ) === 1 ){ $product = $line_item[0]->get_product(); $event_title = $product->get_name(); $metadata[ __( 'Event Title', 'woocommerce-gateway-stripe' ) ] = 'Event Title: ' . sanitize_text_field( $event_title ); } else { //do the line item iteration } You should probably do some testing about the product type and name before you run this code if you ever plan to offer products other than the event ticket, Hop that helps. — Reply to this email directly, view it on GitHub <https://gist.github.com/DeveloperWil/0decf69258a03d6a18eea8e8a6eac252#gistcomment-4762008> or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2NWZGNXZDYDRGSI2HJ26NTYEVOGXBFKMF2HI4TJMJ2XIZLTSKBKK5TBNR2WLJDHNFZXJJDOMFWWLK3UNBZGKYLEL52HS4DFQKSXMYLMOVS2I5DSOVS2I3TBNVS3W5DIOJSWCZC7OBQXE5DJMNUXAYLOORPWCY3UNF3GS5DZVRZXKYTKMVRXIX3UPFYGLK2HNFZXIQ3PNVWWK3TUUZ2G64DJMNZZDAVEOR4XAZNEM5UXG5FFOZQWY5LFVEYTAOBXGQ2TIMRWU52HE2LHM5SXFJTDOJSWC5DF>. You are receiving this email because you were mentioned. Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

I am now trying to get the product category from the order variable.

Here’s the latest code I was attempting that I found on stack overflow:

"As you mentioned get_categories() method of WC_Product class is deprecated. Instead you can use get_category_ids() method. However this method returns product category IDs, and It seems that you need category names so we can get the names from WP_Term objects.

Final code would be something like this:

add_action('woocommerce_checkout_create_order_line_item', 'add_order_item_custom_meta', 10, 4 );
function add_order_item_custom_meta($item, $cart_item_key, $cart_item, $order)
{
$product = $item->get_product(); // The WC_Product instance Object
$cat_ids = $product->get_category_ids(); // returns an array of cat IDs
$cat_names = [];

foreach ( (array) $cat_ids as $cat_id) {
    $cat_term = get_term_by('id', (int)$cat_id, 'product_cat');
    if($cat_term){
        $cat_names[] = $cat_term->name; // You may want to get slugs by $cat_term->slug
    }
}

$item->update_meta_data( '_raw_product_id', $product->get_id() );
$item->update_meta_data( '_raw_product_name', $cat_names );

};
"
I added this below your function for wbdc_filter_wc_stripe_payment_metadata but I’m getting an error processing message.
In researching the issue, I’ve found suggestions to use the $terms =wp_get_post_terms($post->ID, ‘product-cat’);
Or $terms = wp_get_post_terms( $item->get_product_id(), 'product_cat', array( 'fields' => 'names' ) );
I’ve tried adding these lines to your original code but I can’t seem to get them to work correctly. If you have any advice, I’d appreciate it. Thanks again for your help.

Hi, I need help. The code worked very well for me until I updated the version of WooCommerce 5 days ago, since then it has not loaded the metadata in Stripe, not even an error message appears.

Hi, I need help. The code worked very well for me until I updated the version of WooCommerce 5 days ago, since then it has not loaded the metadata in Stripe, not even an error message appears.

The hook has nothing to do with the WooCommerce plugin. The hook is in the WooCommerce Stripe Payment Gateway plugin https://en-au.wordpress.org/plugins/woocommerce-gateway-stripe/.

Here's the line of code with the hook https://github.com/search?q=repo%3Awoocommerce%2Fwoocommerce-gateway-stripe%20wc_stripe_payment_metadata&type=code.

WooCommere has been pushing hard for everyone to upgrade to the new payment gateway WooPayments. If you are using the new WooPayments plugin, there is no equivalent, sorry.

thank you

Hello. I am trying to follow your tutorial here. Am I in the right place for the code discussed? I did not see the direct github link in the video description.

https://www.youtube.com/watch?v=I82v_QOgt9Y

Hello. I am trying to follow your tutorial here. Am I in the right place for the code discussed? I did not see the direct github link in the video description.

https://www.youtube.com/watch?v=I82v_QOgt9Y

Yes, this is the code repository.