github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-08-31 12:32:52 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #5822] docs: fix incorrect unique constraint on subscription.referenceId #14499

New Issue
Closed
opened 2026-04-13 09:30:26 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-13 09:30:26 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/better-auth/better-auth/pull/5822

State: closed
Merged: Yes

Summary

This PR fixes a documentation error that causes users to create a buggy database schema, leading to the "duplicate key error" reported in #5781.

The issue is not in the plugin's code (which works correctly), but in the documentation that misleads users into adding an incorrect unique constraint.

The Problem

  1. User's Bug: Issue #5781 reports a "duplicate key error" when users try to resubscribe after cancellation. This only happens if their database has a UNIQUE constraint on referenceId.

  2. Documentation Error: Our docs (docs/content/docs/plugins/stripe.mdx, line 617) incorrectly state:

    { 
  name: "referenceId", 
  isUnique: true  // ❌ WRONG - causes users to add unique constraint
}

Actual Code: The plugin's schema (packages/stripe/src/schema.ts) correctly does NOT specify unique: true.

Result: Users (especially those using Mongoose or manual schema creation) follow the documentation and add a unique constraint, which breaks the resubscription flow.

The Fix
Update documentation to match the actual implementation:

Change isUnique: true → isUnique: false
Add clear warning: "This should NOT be a unique field in your database, as it must allow users to resubscribe after a cancellation."

Summary by cubic

Corrected Stripe plugin docs: subscription.referenceId is not unique. This prevents users from adding a bad unique constraint that causes duplicate key errors on resubscribe.

Written for commit f0bd57a0cc. Summary will update automatically on new commits.

**Original Pull Request:** https://github.com/better-auth/better-auth/pull/5822 **State:** closed **Merged:** Yes --- ## Summary This PR fixes a documentation error that causes users to create a buggy database schema, leading to the "duplicate key error" reported in #5781. **The issue is not in the plugin's code** (which works correctly), but in the **documentation** that misleads users into adding an incorrect unique constraint. ## The Problem 1. **User's Bug:** Issue #5781 reports a "duplicate key error" when users try to resubscribe after cancellation. This only happens if their database has a `UNIQUE` constraint on `referenceId`. 2. **Documentation Error:** Our docs (`docs/content/docs/plugins/stripe.mdx`, line 617) incorrectly state: ```markdown { name: "referenceId", isUnique: true // ❌ WRONG - causes users to add unique constraint } Actual Code: The plugin's schema (packages/stripe/src/schema.ts) correctly does NOT specify unique: true. Result: Users (especially those using Mongoose or manual schema creation) follow the documentation and add a unique constraint, which breaks the resubscription flow. **The Fix** Update documentation to match the actual implementation: Change isUnique: true → isUnique: false Add clear warning: "This should NOT be a unique field in your database, as it must allow users to resubscribe after a cancellation." <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Corrected Stripe plugin docs: subscription.referenceId is not unique. This prevents users from adding a bad unique constraint that causes duplicate key errors on resubscribe. <sup>Written for commit f0bd57a0cc4ee47af7fb752c18039f34a83dc935. Summary will update automatically on new commits.</sup> <!-- End of auto-generated description by cubic. -->
GiteaMirror added the pull-request label 2026-04-13 09:30:26 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No labels pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
GiteaMirror ninjasurge (Kaehlen Rog)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#14499