Documentation
Platform Settings
This guide describes how to configure platform settings in your Serial Subscriptions instance. These screens control how your site is named, how it looks, how Stripe and sign-in work with your product, and where users are sent when they use Home, Login, and Logout in the main menu.
If you created this Serial Subscriptions instance (for example by completing project setup and provisioning), you are assigned the platform_admin role for that instance. That role can open the Platform Setup Checklist and is intended to complete the settings described here.
Who can open these screens
- View platform settings — You can open each settings page and review values. Fields you are not allowed to change appear disabled.
- Administer platform settings — You can edit and save all fields on these pages.
Where to start: Platform Setup Checklist
In the main navigation, open Platform Settings. That opens the Platform Setup Checklist: a list of setup steps (such as site name, theme, Stripe, and application URLs). Each row has a short description and a button (for example Modify) that takes you to the right screen.
Saving any of the forms described below returns you to this checklist so you can continue with the next item.
You can also use Cancel on a settings form to go back to the checklist without saving.
Platform Settings (site name)
Purpose: Set the site name shown across your Serial Subscriptions instance.
- Open the checklist and choose Modify on Platform Settings, or go to Platform Settings → Platform Settings if your menu exposes that path directly.
- Enter the Site name (required). This is the public name for your environment, not necessarily your product’s marketing name alone—use whatever should appear as the site title in this instance.
- Save the form.
Theme Settings
Purpose: Control branding (logo and optional custom CSS) and fonts used by the default theme.
The page is grouped into two sections:
Brand
- Logo URL (optional) — Full
https://URL to an image used as your logo in theme layouts. - Brand CSS URL (optional) — Full
https://URL to a stylesheet loaded on every page for extra branding or layout tweaks.
Leave a field empty if you do not need it. URLs must be valid web addresses.
Font settings
For each of Sans-serif font, Monospace font, and Serif font, pick a family from the list or leave Default to use the theme’s built-in choice.
If theme settings are not available on your instance, the page shows a short message instead of the form. In that case, theme integration may not be installed for your deployment—contact your administrator.
Stripe Settings
Purpose: Connect your Stripe account, choose test vs live behavior, and configure webhooks so payments and payment methods stay in sync.
Environment
Choose Test or Live. The form then shows the credential fields for that mode. You can configure both test and live keys over time; the environment selection controls which set is active for processing.
Keys (Test or Live, depending on environment)
For the active mode, provide:
- Publishable key — From the Stripe Dashboard (test or live, matching your selection).
- Secret key — Treated as sensitive. If a value is already stored, the field may show a placeholder mask. To keep the existing secret, leave that mask as-is. To replace it, type the new secret. To clear it, remove the contents entirely and save (if your workflow allows empty secrets).
- Webhook secret — From the signing secret of the webhook endpoint you create in Stripe (see below). Same masking behavior as the secret key.
Links on the form point to Stripe’s key and webhook pages in the correct mode (test vs live).
Webhook endpoint URL
The form displays your instance’s Webhook Endpoint URL (your site’s address plus the webhook path). Use click to copy (or select the value) and paste it into Stripe when you create the webhook endpoint.
Create or update the endpoint in Stripe so it uses that exact URL.
Events to enable
Expand Stripe events to enable to see which event groups must be turned on in Stripe. Enable all payment_intent.* events and all payment_method.* events for that endpoint.
Saved payment methods
Enable saved payment methods — When checked, the platform can use Stripe’s saved payment method behavior appropriate to your checkout flows (so returning customers can reuse cards where supported).
Auth Settings (OAuth application)
For a full walkthrough aligned with the @serialsubscriptions/platform-integration npm package (environment variables and auth route template), see OAuth settings.
Purpose: Configure the default OAuth client your applications use to sign users in with this Serial Subscriptions instance (client name, identifiers, secrets, grants, scopes, and redirect addresses).
If no default client exists yet, the page shows instructions for administrators: create a consumer, mark it as the default OAuth client in the site’s administrative configuration, then open this page again.
Client identity
- Client name — Label for this OAuth client (required).
- Client ID — Public identifier for the client (required). Must be unique for this authorization server.
New client secret
- Paste a secret you already use, or use Generate to create one. Copy copies the current field value; Clear empties the field so you can start over.
- Until you save, generated or pasted values exist only in the form. After save, treat the secret like any production credential.
Grant types
Enable Authorization code and/or Refresh token according to what your apps implement. Enable only what you need.
Scope selection
- All scopes (recommended) — The client may request any scope that appears in this screen’s list.
- Selected scopes — Restrict the client to the checkboxes you pick. At least one scope is required if you choose this option.
Redirect URIs
Enter one URI per line. These are the allowed callback URLs for the authorization code flow (for example your app’s OAuth callback URL).
Additional OAuth Settings
Expand this section for advanced options:
- Confidential client — Typical for server-side apps that can keep a client secret safe.
- Require PKCE — Use when your apps must use PKCE (common for public clients and many modern stacks).
- Access token expiration (seconds) — How long access tokens remain valid before users need a refresh or new authorization.
- Refresh token expiration (seconds) — How long refresh tokens remain valid; use values that fit your security and compliance needs.
- Automatic authorization — When possible, skips the manual approval screen.
- Remember approvals — Whether user approvals can be remembered for future authorizations.
Save when finished. The Platform Setup Checklist updates to reflect that OAuth settings have been saved.
Application Settings
Purpose: Tell the platform where your product app lives and how Home, Login, and Logout should behave for end users.
All URL fields must be full absolute URLs (including https://).
- Application Home — Base URL of your application (for example the root of your
appsubdomain). Used as context for where users “live” in your product. - Login redirect URL — URL that starts the OAuth login flow in your app (the sign-in entry point).
- Logout URL — URL that performs or starts logout in your app.
Use Login redirect URL as Home for logged-in users — When checked, authenticated users who choose Home in the main menu are sent to the same destination as the login redirect URL. When unchecked, Home uses the Application Home URL instead.
Saving updates the main menu entries for Home (anonymous and logged-in) and Logout so they route through the platform’s app helpers using these URLs.
Checklist items outside this module
The Platform Setup Checklist also includes steps that are not edited on the pages above:
- Organization Information — Creating or joining an organization for your account (see Sign up for the user-level flow).
- Subscription Plans — Managing or importing plans for billing.
Use the Manage, Create, Modify, or Import buttons on those checklist rows to complete those steps.
Quick reference: page titles
| What you need | Typical page title in the admin UI |
|---|---|
| Site name | Platform Settings |
| Logo, CSS, fonts | Theme Settings |
| Stripe keys and webhooks | Stripe Settings |
| OAuth client | Auth Settings |
| App and auth URLs | Application Settings |
| Overview of all steps | Platform Setup Checklist |
Exact menu labels may match these titles or be grouped under Platform Settings depending on your theme and permissions.