docs(web-checkout): rename Stripe "Secret Key" field to "Restricted Key" - #268
Draft
claude[bot] wants to merge 1 commit into
Draft
docs(web-checkout): rename Stripe "Secret Key" field to "Restricted Key"#268claude[bot] wants to merge 1 commit into
claude[bot] wants to merge 1 commit into
Conversation
The Stripe settings credential field in the dashboard is now labelled "Restricted Key". The credential itself is unchanged: it has always been the restricted key that Superwall's Stripe app generates during install (rk_live_ for live, rk_test_ for sandbox), and sk_ keys were always rejected. Also corrects the Settings overview description, which told customers to create a Stripe secret key themselves. That was never followable — the Stripe app generates the restricted key for you. Source change: superwall/paywall-next#3843 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SPRcJ7nE5E7EfUQ2M5gebA
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
superwall-docs | 5564ae6 | Commit Preview URL Branch Preview URL |
Aug 17 2026, 01:18 PM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Yusuf Tör · Slack thread
What this does
Renames the Stripe credential field in the docs from "Secret Key" to "Restricted Key" so it matches the dashboard, and fixes a setup instruction that was never followable.
Before / After
Before — the docs called the Stripe settings credential "Secret Key", and the Settings overview page told you to create a Stripe secret key yourself: "A Stripe secret key that you create. Once you've made one, paste it here." Nobody could follow that. The dashboard has only ever accepted the restricted key (
rk_live_/rk_test_) that Superwall's Stripe app generates for you during install, andsk_keys have always been rejected.After — every page names the field "Restricted Key", and the Settings overview explains that Superwall's Stripe app generates the key for you —
rk_live_for live,rk_test_for sandbox — rather than telling you to create one. The credential itself is unchanged; only the label and the wrong instruction change.How
Four content pages updated:
content/docs/dashboard/dashboard-settings/overview-settings.mdx— under Stripe Live Configuration and Stripe Sandbox Configuration, item 2 becomes Restricted Key, with the description rewritten to say the Stripe app generates it (naming therk_live_/rk_test_prefix per section).content/docs/web-checkout/web-checkout-configuring-stripe-keys-and-settings.mdx— the Superwall destination field in Step 7 (live) is now Restricted Key. The sandbox Step 6 now names both destination fields explicitly instead of saying "paste both keys", matching the live flow. Wording that describes what Stripe itself hands back ("Restricted Secret Key") is left as Stripe's own terminology.content/docs/web-checkout/web-checkout-managed-payments.mdx— "a valid publishable key and secret key" → "restricted key".content/docs/support/web-checkout/web-checkout-revenue-tracking-is-automatic.mdx— same rename in the troubleshooting step.No page instructs anyone to enter an
sk_key any more. The legacy "Stripe Private Key" field is deliberately not documented — it is a dead credential and no page mentions it.Source change: superwall/paywall-next#3843
Follow-up: stale screenshots
Two images still show the old Secret Key label and should be recaptured in a separate pass:
/images/web2app_live_config.png(Stripe Live Configuration, "Configured" state)/images/stripe/step-6-copy-keys.png(Step 6, copying keys out of the Stripe app)Not regenerated here.