[PR #3647] [MERGED] docs: fix wrong cancelUrl and returnUrl descriptions #30533

Closed
opened 2026-04-17 21:35:31 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/3647
Author: @acusti
Created: 7/27/2025
Status: Merged
Merged: 8/1/2025
Merged by: @Bekacru

Base: mainHead: docs/stripe-plugin-cancel-return-urls


📝 Commits (3)

  • 6a61d24 docs: fix wrong cancelUrl and returnUrl descriptions
  • 089a64d chore: changeset
  • bc61a29 chore: update changeset

📊 Changes

3 files changed (+12 additions, -6 deletions)

View changed files

.changeset/mighty-tables-dream.md (+5 -0)
📝 docs/content/docs/plugins/stripe.mdx (+4 -3)
📝 packages/stripe/src/index.ts (+3 -3)

📄 Description

In the stripe plugin’s upgradeSubscription and cancelSubscription prop annotations and in the stripe plugin doc’s descriptions, the callbackUrl and returnUrl were copypasta’d from the successUrl prop. So I looked at how both are used in the plugin and fixed the annotations based on that:

  • returnUrl is passed to the stripe client’s client.billingPortal.sessions.create(…) invocation in both endpoints, so I used shortened versions of the description from the stripe docs for that parameter for both instances
  • cancelUrl is passed to client.checkout.sessions.create(…), so I shortened the description from the stripe docs for that parameter

Summary by cubic

Updated the descriptions for cancelUrl and returnUrl in the Stripe plugin code and docs to match their actual usage and the Stripe API documentation.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/3647 **Author:** [@acusti](https://github.com/acusti) **Created:** 7/27/2025 **Status:** ✅ Merged **Merged:** 8/1/2025 **Merged by:** [@Bekacru](https://github.com/Bekacru) **Base:** `main` ← **Head:** `docs/stripe-plugin-cancel-return-urls` --- ### 📝 Commits (3) - [`6a61d24`](https://github.com/better-auth/better-auth/commit/6a61d246b13fa3994efa71c59dfc53567663df33) docs: fix wrong cancelUrl and returnUrl descriptions - [`089a64d`](https://github.com/better-auth/better-auth/commit/089a64d26c293aa624e26a7a649922594f4c802d) chore: changeset - [`bc61a29`](https://github.com/better-auth/better-auth/commit/bc61a29bc7fc4b05bd1de0750f600a6f73790ca4) chore: update changeset ### 📊 Changes **3 files changed** (+12 additions, -6 deletions) <details> <summary>View changed files</summary> ➕ `.changeset/mighty-tables-dream.md` (+5 -0) 📝 `docs/content/docs/plugins/stripe.mdx` (+4 -3) 📝 `packages/stripe/src/index.ts` (+3 -3) </details> ### 📄 Description In the stripe plugin’s `upgradeSubscription` and `cancelSubscription` prop annotations and in the stripe plugin doc’s descriptions, the `callbackUrl` and `returnUrl` were copypasta’d from the `successUrl` prop. So I looked at how both are used in the plugin and fixed the annotations based on that: - `returnUrl` is passed to the stripe client’s `client.billingPortal.sessions.create(…)` invocation in both endpoints, so I used shortened versions of the description from the [stripe docs for that parameter](https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url) for both instances - `cancelUrl` is passed to `client.checkout.sessions.create(…)`, so I shortened the description from the [stripe docs for that parameter](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-cancel_url) <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Updated the descriptions for cancelUrl and returnUrl in the Stripe plugin code and docs to match their actual usage and the Stripe API documentation. <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-17 21:35:31 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#30533