WCS & Stripe: add payment metadata and update renewal description #2254

adekbadek · 2023-01-27T16:32:36Z

All Submissions:

Have you followed the Newspack Contributing guideline?
Does your code follow the WordPress' coding standards and VIP Go coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

WC Stripe Gateway plugin adds little metadata to any Stripe payment. It's not possible to learn that a payment was related to a specific subscription. WCSG only adds the order_id metadata and indicates a WC Subscription with a payment_type='recurring' metadata.

To make any third-party integrations more aware of what WCS is doing in Stripe:

subscription_id will be added to any payments which are WC Subscriptions renewals
subscription_status will be added, either created or renewed
additionally, for Newspack-originating subscriptions, the payment description will be updated to Newspack <frequency> Donation (Order <id>, Subscription <id>) (e.g. Newspack Monthly Donation (Order #756, Subscription #757))

How to test the changes in this Pull Request:

Set up Stripe, ensure the site is reachable by Stripe webhooks
Ensure the WC suite is active, and "Stripe – Credit Card (Stripe)" set as the only payment method in WC
Set the environment variable NEWSPACK_USE_WC_SUBSCRIPTIONS_WITH_STRIPE_PLATFORM to true (see Stripe: create native WC Subscriptions (if a flag is set) #2251)
Make a recurring donation using SDB
Open the resulting WC Subscription in WP Admin an renew it manually (via the "Subscription actions" meta box)
Go to Stripe dashboard, inspect the initial payment and the renewal payment – both should have subscription_id meta set (to the applicable value), the first one should have the subscription_status meta set to created, and the second one to renewed. Both should have origin meta set to newspack.

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you successfully ran tests with your changes locally?

leogermani · 2023-01-27T16:58:38Z

That's awesome, thanks!

Would it be possible/easy to add what payment of the subscription this is? (if it's the 1st payment, second, etc... just a number 1, 2, 3...?)

The primary goal of that would be to easily identify new subscriptions from ongoing ones.

We could also edit the description and add "New subscription" or something

leogermani · 2023-01-27T17:05:07Z

ah..

another thing we identified is that we could add a origin=>newspack metadata.

I know we have referer... but this would be more generic. See pamTN9-5II-p2#comment-7375

adekbadek · 2023-01-30T10:38:35Z

The primary goal of that would be to easily identify new subscriptions from ongoing ones.

There will be subscription_status meta with created or renewed value, would that suffice?

another thing we identified is that we could add a origin=>newspack metadata.

Added in 5e0598f.

leogermani · 2023-02-08T12:07:41Z

There will be subscription_status meta with created or renewed value, would that suffice?

Yes, that's good. What are all the possible values? For a regular payment during a subscription what would this look like?

adekbadek · 2023-02-13T10:48:45Z

For a regular payment during a subscription what would this look like?

That would be renewed.

# [1.103.0-alpha.2](v1.103.0-alpha.1...v1.103.0-alpha.2) (2023-02-17) ### Bug Fixes * **ads-wizard:** cancelled state of unit displayed on the list ([#2272](#2272)) ([e10b592](e10b592)) * **ads:** remove fixed height setting ([#2255](#2255)) ([0031b89](0031b89)) * change default auth strategy to "link" ([#2261](#2261)) ([c4b2e2c](c4b2e2c)) * update package.json to resolve a merge conflict with master ([f2408a3](f2408a3)) * **webhooks:** check if endpoint exists ([#2276](#2276)) ([5a95e2c](5a95e2c)) ### Features * bootstrap GA4 connector ([#2241](#2241)) ([f7582a4](f7582a4)) * **data-events:** mailchimp connector ([#2233](#2233)) ([08060c6](08060c6)) * **data-events:** standardize the use of "user_id" and "email" ([#2263](#2263)) ([d6b6903](d6b6903)) * **donations:** add payment metadata and update renewal description ([#2254](#2254)) ([b039304](b039304)) * **my-account:** display stripe billing link regardless of RR platform ([df540fe](df540fe)) * **perfmatters:** defaults adjustments, remove feature flag ([#2271](#2271)) ([cf5ad51](cf5ad51)) * **performance:** minify all inline CSS ([#2239](#2239)) ([fbb415f](fbb415f)) * **ras:** enable custom contact metadata prefixes ([#2249](#2249)) ([e9843e4](e9843e4)) * require all woo plugins for RAS ([#2260](#2260)) ([5f6a818](5f6a818)) * **stripe:** create native WC Subscriptions (if feature flag is set) ([#2251](#2251)) ([009a8a5](009a8a5)) * **webhooks:** support label for endpoints ([#2262](#2262)) ([39da7be](39da7be))

matticbot · 2023-02-17T10:05:06Z

🎉 This PR is included in version 1.103.0-alpha.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [1.104.0-alpha.1](v1.103.0...v1.104.0-alpha.1) (2023-02-17) ### Bug Fixes * **ads-wizard:** cancelled state of unit displayed on the list ([#2272](#2272)) ([e10b592](e10b592)) * **ads:** remove fixed height setting ([#2255](#2255)) ([0031b89](0031b89)) * change default auth strategy to "link" ([#2261](#2261)) ([c4b2e2c](c4b2e2c)) * **webhooks:** check if endpoint exists ([#2276](#2276)) ([5a95e2c](5a95e2c)) ### Features * bootstrap GA4 connector ([#2241](#2241)) ([f7582a4](f7582a4)) * **data-events:** mailchimp connector ([#2233](#2233)) ([08060c6](08060c6)) * **data-events:** standardize the use of "user_id" and "email" ([#2263](#2263)) ([d6b6903](d6b6903)) * **donations:** add payment metadata and update renewal description ([#2254](#2254)) ([b039304](b039304)) * **my-account:** display stripe billing link regardless of RR platform ([df540fe](df540fe)) * **perfmatters:** defaults adjustments, remove feature flag ([#2271](#2271)) ([cf5ad51](cf5ad51)) * **performance:** minify all inline CSS ([#2239](#2239)) ([fbb415f](fbb415f)) * **ras:** enable custom contact metadata prefixes ([#2249](#2249)) ([e9843e4](e9843e4)) * require all woo plugins for RAS ([#2260](#2260)) ([5f6a818](5f6a818)) * **stripe:** create native WC Subscriptions (if feature flag is set) ([#2251](#2251)) ([009a8a5](009a8a5)) * **webhooks:** support label for endpoints ([#2262](#2262)) ([39da7be](39da7be))

matticbot · 2023-02-17T11:02:12Z

🎉 This PR is included in version 1.104.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [1.105.0-alpha.1](v1.104.0...v1.105.0-alpha.1) (2023-02-20) ### Bug Fixes * **ads-wizard:** cancelled state of unit displayed on the list ([#2272](#2272)) ([e10b592](e10b592)) * **ads:** remove fixed height setting ([#2255](#2255)) ([0031b89](0031b89)) * change default auth strategy to "link" ([#2261](#2261)) ([c4b2e2c](c4b2e2c)) * **webhooks:** check if endpoint exists ([#2276](#2276)) ([5a95e2c](5a95e2c)) ### Features * bootstrap GA4 connector ([#2241](#2241)) ([f7582a4](f7582a4)) * **data-events:** mailchimp connector ([#2233](#2233)) ([08060c6](08060c6)) * **data-events:** standardize the use of "user_id" and "email" ([#2263](#2263)) ([d6b6903](d6b6903)) * **donations:** add payment metadata and update renewal description ([#2254](#2254)) ([b039304](b039304)) * **my-account:** display stripe billing link regardless of RR platform ([df540fe](df540fe)) * **perfmatters:** defaults adjustments, remove feature flag ([#2271](#2271)) ([cf5ad51](cf5ad51)) * **performance:** minify all inline CSS ([#2239](#2239)) ([fbb415f](fbb415f)) * **ras:** enable custom contact metadata prefixes ([#2249](#2249)) ([e9843e4](e9843e4)) * require all woo plugins for RAS ([#2260](#2260)) ([5f6a818](5f6a818)) * **stripe:** create native WC Subscriptions (if feature flag is set) ([#2251](#2251)) ([009a8a5](009a8a5)) * **webhooks:** support label for endpoints ([#2262](#2262)) ([39da7be](39da7be))

matticbot · 2023-02-20T10:10:31Z

🎉 This PR is included in version 1.105.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

matticbot · 2023-02-27T10:38:41Z

🎉 This PR is included in version 1.105.0-hotfix-hpb-amp-optimisations.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# [1.105.0](v1.104.1...v1.105.0) (2023-02-28) ### Bug Fixes * **ads-wizard:** cancelled state of unit displayed on the list ([#2272](#2272)) ([e10b592](e10b592)) * **ads:** remove fixed height setting ([#2255](#2255)) ([0031b89](0031b89)) * change default auth strategy to "link" ([#2261](#2261)) ([c4b2e2c](c4b2e2c)) * **webhooks:** check if endpoint exists ([#2276](#2276)) ([5a95e2c](5a95e2c)) ### Features * bootstrap GA4 connector ([#2241](#2241)) ([f7582a4](f7582a4)) * **data-events:** mailchimp connector ([#2233](#2233)) ([08060c6](08060c6)) * **data-events:** standardize the use of "user_id" and "email" ([#2263](#2263)) ([d6b6903](d6b6903)) * **donations:** add payment metadata and update renewal description ([#2254](#2254)) ([b039304](b039304)) * **my-account:** display stripe billing link regardless of RR platform ([df540fe](df540fe)) * **perfmatters:** defaults adjustments, remove feature flag ([#2271](#2271)) ([cf5ad51](cf5ad51)) * **performance:** minify all inline CSS ([#2239](#2239)) ([fbb415f](fbb415f)) * **ras:** enable custom contact metadata prefixes ([#2249](#2249)) ([e9843e4](e9843e4)) * require all woo plugins for RAS ([#2260](#2260)) ([5f6a818](5f6a818)) * **stripe:** create native WC Subscriptions (if feature flag is set) ([#2251](#2251)) ([009a8a5](009a8a5)) * **webhooks:** support label for endpoints ([#2262](#2262)) ([39da7be](39da7be))

matticbot · 2023-02-28T13:09:44Z

🎉 This PR is included in version 1.105.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

adekbadek requested a review from a team as a code owner January 27, 2023 16:32

adekbadek marked this pull request as draft January 27, 2023 16:32

adekbadek force-pushed the feat/wcs-stripe-metadata branch from 22fb4bd to 525ebc2 Compare January 27, 2023 16:35

adekbadek force-pushed the feat/wcs-stripe-metadata branch 2 times, most recently from 78093be to 5e0598f Compare January 30, 2023 10:38

Base automatically changed from feat/sdb-native-wc-subs to master February 13, 2023 10:43

adekbadek added 3 commits February 13, 2023 11:45

refactor: return subscription ID from transaction creation method

Verified

This commit was signed with the committer’s verified signature.

miguelpeixe Miguel Peixe

GPG key ID: 2F41B04D42A57382

Verified
Learn about vigilant mode

4261bab

feat: add subscription-related metadata to Stripe payments

Verified

This commit was signed with the committer’s verified signature.

miguelpeixe Miguel Peixe

GPG key ID: 2F41B04D42A57382

Verified
Learn about vigilant mode

4044724

feat: add 'origin' meta

Verified

This commit was signed with the committer’s verified signature.

miguelpeixe Miguel Peixe

GPG key ID: 2F41B04D42A57382

Verified
Learn about vigilant mode

8d9490c

adekbadek force-pushed the feat/wcs-stripe-metadata branch from 5e0598f to 8d9490c Compare February 13, 2023 10:47

feat: remove redundant is_newspack meta field

Verified

This commit was signed with the committer’s verified signature.

miguelpeixe Miguel Peixe

GPG key ID: 2F41B04D42A57382

Verified
Learn about vigilant mode

ebb298f

adekbadek marked this pull request as ready for review February 13, 2023 10:57

adekbadek added [Status] Needs Review Reader Revenue Stripe WooCommerce labels Feb 13, 2023

leogermani approved these changes Feb 15, 2023

View reviewed changes

github-actions bot added [Status] Approved and removed [Status] Needs Review labels Feb 15, 2023

adekbadek merged commit b039304 into master Feb 15, 2023

adekbadek deleted the feat/wcs-stripe-metadata branch February 15, 2023 13:03

matticbot added the released on @alpha label Feb 17, 2023

matticbot added the released on @hotfix/hpb-amp-optimisations label Feb 27, 2023

matticbot added the released label Feb 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WCS & Stripe: add payment metadata and update renewal description #2254

WCS & Stripe: add payment metadata and update renewal description #2254

adekbadek commented Jan 27, 2023 •

edited

Loading

leogermani commented Jan 27, 2023 •

edited

Loading

leogermani commented Jan 27, 2023

adekbadek commented Jan 30, 2023

leogermani commented Feb 8, 2023 •

edited

Loading

adekbadek commented Feb 13, 2023

matticbot commented Feb 17, 2023

matticbot commented Feb 17, 2023

matticbot commented Feb 20, 2023

matticbot commented Feb 27, 2023

matticbot commented Feb 28, 2023

WCS & Stripe: add payment metadata and update renewal description #2254

WCS & Stripe: add payment metadata and update renewal description #2254

Conversation

adekbadek commented Jan 27, 2023 • edited Loading

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

leogermani commented Jan 27, 2023 • edited Loading

leogermani commented Jan 27, 2023

adekbadek commented Jan 30, 2023

leogermani commented Feb 8, 2023 • edited Loading

adekbadek commented Feb 13, 2023

matticbot commented Feb 17, 2023

matticbot commented Feb 17, 2023

matticbot commented Feb 20, 2023

matticbot commented Feb 27, 2023

matticbot commented Feb 28, 2023

adekbadek commented Jan 27, 2023 •

edited

Loading

leogermani commented Jan 27, 2023 •

edited

Loading

leogermani commented Feb 8, 2023 •

edited

Loading