feat: Add more metadata to Stripe transaction by kcrimi · Pull Request #11221 · calcom/cal.com

kcrimi · 2023-09-07T21:40:24Z

What does this PR do?

This PR adds additional information to Stripe metadata and tweaks data added in a previous PR for better usability:

organizer id and username - used to identify the cal user when multiple cal accounts are linked to the same Stripe account
event type title instead of event title - allows aggregating across all like bookings by event type for total earnings by event type, the individual title is less useful
bookerName - useful in interacting with user for charge disputes

Fixes #10668, #10678, #8205

Requirement/Documentation

Original request was added here

Type of change

New feature (non-breaking change which adds functionality)

How should this be tested?

Have an organizer account with a linked stripe account offer a paid event type
Create a booking of that paid event type
Metadata should show in the Stripe transaction:

Mandatory Tasks

Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.

Checklist

I haven't added tests that prove my fix is effective or that my feature works

vercel · 2023-09-07T21:40:30Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 14, 2023 4:04am

CLAassistant · 2023-09-07T21:40:31Z

All committers have signed the CLA.

vercel · 2023-09-07T21:40:32Z

@kcrimi is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

github-actions · 2023-09-07T21:40:37Z

Thank you for following the naming conventions! 🙏

github-actions · 2023-09-07T21:48:15Z

📦 Next.js Bundle Analysis for @calcom/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

…adata

kcrimi

@shirazdole @alannnc this builds upon #10678 to get all the information I'd need.

Happy to add/change anything if needed

kcrimi · 2023-09-07T22:35:14Z

packages/features/bookings/lib/handleNewBooking.ts

          name: true,
          email: true,
          timeZone: true,
+          username: true,


Had to add the username to the query since it was previously only getting name, email, and timezone for the organizer

kcrimi · 2023-09-07T22:35:55Z

packages/lib/payment/handlePayment.ts

 const handlePayment = async (
  evt: CalendarEvent,
-  selectedEventType: Pick<Zod.infer<typeof EventTypeModel>, "metadata">,
+  selectedEventType: Pick<Zod.infer<typeof EventTypeModel>, "metadata" | "title">,


Getting the title in addition to the metadata for the event type now

kcrimi · 2023-09-07T22:38:10Z

packages/lib/payment/handlePayment.ts

      bookerEmail,
      paymentOption,
-      evt.title
+      selectedEventType.title


Previous PR added the event title (eg "30 minute meeting with Roald Dahl") instead of the event type title (eg "30 minute meeting").

Because I'm looking to use multiple accounts on the same Stripe account, it would be more useful to be able to aggregate on the event type title to show earninings per event type.

If it's also useful to have the calendar event title, I can add it back in addition.

Yeah, let's keep both. BookingTitle and eventTitle. What you think?

PeerRich

LGTM, waiting for @alannnc

alannnc · 2023-09-11T21:18:22Z

.tool-versions

@@ -0,0 +1 @@
+nodejs 20.3.1


Uncheck this file from the PR.

alannnc

Left some comments. Will leave with request changes for a moment, if I find time I will address the issues.

kcrimi · 2023-09-11T23:07:08Z

🙏 Thanks @alannnc, pushed some changes

* Add booker info, event type title, and organizer info into Stripe metadata * Add back bookingTitle in addition to eventTitle * Remove .tool-versions * Fix typo --------- Co-authored-by: alannnc <alannnc@gmail.com>

github-actions bot added billing area: billing, stripe, payments, paypal, get paid Medium priority Created by Linear-GitHub Sync ✨ feature New feature or request 🚧 wip / in the making This is currently being worked on labels Sep 7, 2023

kcrimi changed the title ~~Add more metadata to Stripe transaction~~ feat: Add more metadata to Stripe transaction Sep 7, 2023

vercel bot deployed to Preview – ui September 7, 2023 21:44 View deployment

Add booker info, event type title, and organizer info into Stripe met…

5c944d1

…adata

kcrimi force-pushed the feature/more-stripe-data branch from 033dd44 to 5c944d1 Compare September 7, 2023 22:30

vercel bot deployed to Preview – ui September 7, 2023 22:33 View deployment

kcrimi commented Sep 7, 2023

View reviewed changes

This was referenced Sep 11, 2023

Provide information to link bookings to Stripe payments #10668

Closed

[CAL-1462] Add paid booking metadata to Stripe #8205

Closed

PeerRich requested a review from a team September 11, 2023 20:59

PeerRich previously approved these changes Sep 11, 2023

View reviewed changes

alannnc reviewed Sep 11, 2023

View reviewed changes

.tool-versions Outdated

@@ -0,0 +1 @@

nodejs 20.3.1

Copy link
Copy Markdown

Contributor

alannnc Sep 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uncheck this file from the PR.

alannnc suggested changes Sep 11, 2023

View reviewed changes

kcrimi added 2 commits September 11, 2023 16:02

Add back bookingTitle in addition to eventTitle

7685098

Remove .tool-versions

2515975

kcrimi dismissed PeerRich’s stale review via 2515975 September 11, 2023 23:06

vercel bot deployed to Preview – ui September 11, 2023 23:10 View deployment

Fix typo

44e71ee

vercel bot deployed to Preview – ui September 12, 2023 00:44 View deployment

Merge branch 'main' into feature/more-stripe-data

2720967

vercel bot deployed to Preview – ui September 14, 2023 04:04 View deployment

alannnc approved these changes Sep 14, 2023

View reviewed changes

alannnc requested a review from a team September 14, 2023 04:07

alannnc enabled auto-merge (squash) September 14, 2023 04:08

alannnc merged commit 3a05ae6 into calcom:main Sep 14, 2023

Conversation

kcrimi commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Requirement/Documentation

Type of change

How should this be tested?

Mandatory Tasks

Checklist

Uh oh!

vercel bot commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Sep 7, 2023

Uh oh!

github-actions bot commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Next.js Bundle Analysis for @calcom/web

Uh oh!

kcrimi left a comment

Choose a reason for hiding this comment

Uh oh!

kcrimi Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

kcrimi Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

kcrimi Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

alannnc Sep 11, 2023

Choose a reason for hiding this comment

Uh oh!

PeerRich left a comment

Choose a reason for hiding this comment

Uh oh!

alannnc Sep 11, 2023

Choose a reason for hiding this comment

Uh oh!

alannnc left a comment

Choose a reason for hiding this comment

Uh oh!

kcrimi commented Sep 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kcrimi commented Sep 7, 2023 •

edited

Loading

vercel bot commented Sep 7, 2023 •

edited

Loading

CLAassistant commented Sep 7, 2023 •

edited

Loading

github-actions bot commented Sep 7, 2023 •

edited

Loading

github-actions bot commented Sep 7, 2023 •

edited

Loading