Stripe Apps
StripeOfficialPublished by Stripe
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured approach to developing and maintaining Stripe Apps. It guides users through selecting the correct extension architecture, implementing authentication, building UI components, and managing backend services or webhooks. By leveraging bundled reference files and canonical documentation, it ensures that app development follows Stripe's best practices for security, configuration, and lifecycle management.
What it does
- Provides guidance on selecting the appropriate Stripe extension interface.
- Assists in building and modifying Stripe Dashboard UI components.
- Supports the implementation of backend services, webhooks, and secret storage.
- Helps determine the correct authentication method for Stripe API access.
- Offers instructions for testing, debugging, and publishing Stripe Apps.
- Clarifies the applicability of extensions for specific billing or workflow requirements.
When to use it
- When you need to build a custom UI extension for the Stripe Dashboard.
- When deciding between Restricted API keys, Platform keys, or OAuth for your app.
- When implementing backend logic or handling Stripe events via webhooks.
- When you need to store sensitive credentials securely using the Secret Store API.
- When troubleshooting or modifying an existing Stripe App's manifest or configuration.
Advantages
- Ensures alignment with official Stripe development patterns and security standards.
- Reduces development time by providing clear paths to relevant documentation.
- Helps prevent common architectural errors in app authentication and event handling.
- Provides a consistent workflow for the entire app lifecycle from scaffolding to release.
Usage examples
- “How do I determine if my Stripe App needs a backend?”
- The agent will reference the backend documentation to explain that a backend is required for long-term data storage, server-side secrets, or handling webhooks, while suggesting the Secret Store API for simpler needs.
- “Help me choose the right authentication type for a private Stripe App.”
- The agent will compare Restricted API keys, Platform keys, and OAuth, recommending Restricted API keys as the simplest and most secure choice for private integrations.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/stripe/stripe-apps/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip stripe-apps.zip -d .agents/skills
Documentation by Stripe
Stripe Apps
Select and read the existing guidance for the user’s task. Product documentation describes what an extension can do; implementation guides describe how to build it. Before recommending an extension or writing code, load the applicable bundled reference files as well as the relevant product documentation. A link or filename in this skill isn’t a substitute for reading its contents.
For a capability question, check native Stripe features and the documented applicability and limitations of the extension. For an implementation request, create or modify working files using the selected guide. For an existing app, inspect its manifest, packages, installed SDK, and local agent instructions before deciding what to change.
Choose the relevant documentation
Use information already supplied by the user or existing app. Read <references/discovery.md> when you need to clarify the app’s requirements, and <references/extension-types.md> for an overview of app architectures. Ask only for missing information that affects the task.
Product capabilities
Use these existing product documents to determine which capability fits and whether the account has the required access. Don’t infer support from an extension’s name or the existence of a scaffold.
| Task | Read |
|---|---|
| Select an extension interface and its supported implementation types | Extension points and how extensions work |
| Change how items are included on subscription invoices | Item handling extensions |
| Customize prorations | Native proration behavior and prorations extensions |
| Apply customer balances | Customer balance extensions |
| Calculate discount amounts | Discount calculation extensions |
| Add an action to Stripe Workflows | Existing workflow actions, existing custom actions, and how custom actions work |
| Customize another product’s behavior | Follow the selected interface’s product documentation from the extension-point catalog |
Implementation guidance
The references/*.md files are bundled with this skill. After selecting the capability, load the applicable files before following their links to supporting documentation. Combine rows when an app needs multiple types. Follow the selected guide’s prerequisites, scaffolding, testing, and debugging instructions.
| Task | Read |
|---|---|
| Build or modify any Dashboard UI, including drawers and full-page apps | <references/ui-extensions.md>, then each selected component’s current API documentation |
| Author, test, or debug a script extension | <references/script-extensions.md>, then the selected extension point’s implementation guide |
| Build a custom-action script | <references/script-extensions.md> and build a custom action with a script |
| Build a custom-action remote function | Build a custom action with a remote function |
| Build a self-hosted UI back-end or webhook service | <references/backend.md> and <references/authentication.md>; also load <references/webhooks.md> when receiving Stripe events |
| Store app credentials with the Secret Store API | The Secret Store API section in <references/backend.md> and store secrets, including for apps without a self-hosted back-end |
| Look up APIs, SDK patterns, configuration, or additional extension documentation | <references/canonical-docs.md> |
Use the UI reference for layout and composition, and current component documentation for import paths, props, and styling APIs. For scripts and remote functions, follow the selected extension’s documentation; UI and self-hosted back-end instructions don’t define their runtime capabilities.
Shared app lifecycle
Read these references when the corresponding task is needed. Reuse existing apps and packages; scaffold only what is missing.
| Task | Read |
|---|---|
| Scaffold, build, test, preview, or upload an app | <references/workflow.md>, together with the selected implementation guide |
| Choose authentication for access to Stripe APIs | <references/authentication.md> |
| Receive Stripe events | <references/webhooks.md> |
| Build a first-run setup experience | <references/onboarding-ux.md> and the UI reference |
| Release versions, change installed permissions, or publish to the marketplace | <references/publishing.md> |
| Submit feedback after running app toolchain commands | <references/feedback.md> |
Load bundled reference files
Use the task tables to select every applicable bundled reference under
references/, then open those files with a file-reading tool before starting the corresponding work. For example, UI with a self-hosted back-end needs both UI and back-end guidance; onboarding also needs the UI reference.Follow relevant pointers to other bundled references inside the files you load, including filenames written as code rather than links. For example, back-end guidance can require authentication guidance, and changing permissions can require publishing guidance. Use this skill’s direct links to locate those files.
Read the canonical documentation required by those references. External documentation supplements the bundled guidance on workflow, layout, and other task-specific decisions.
Resolve
references/paths relative to this skill’s directory and bare reference filenames relative to itsreferences/directory. When reading the hosted skill, fetch the corresponding reference URLs relative to the skill URL.Load only references relevant to the task, and reuse contents already read during the session unless they have changed. A full-stack app doesn’t require every document in the skill.
Read canonical pages using the available documentation tools. Prefer
stripe docswhen available, including for pages that require account access.Use current product documentation and the installed SDK’s types for API contracts and limitations. If an example in a reference disagrees, check the version and follow the applicable canonical documentation.
Read any interface-specific agent instructions supplied with an existing or newly generated extension. If none are present, use the linked product and implementation guides.
If the documentation doesn’t establish that an extension meets a requirement, state what is unknown or unsupported before proceeding.
Keep the work within the user’s request. Report the changes, validation results, and remaining steps relevant to that app.
Files
- ATTRIBUTION.mdAdded by AutoGineer819 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md7.6 KiB
- references/authentication.md4.6 KiB
- references/backend.md4.4 KiB
- references/canonical-docs.md4.4 KiB
- references/discovery.md9.2 KiB
- references/extension-types.md5.1 KiB
- references/feedback.md1.9 KiB
- references/onboarding-ux.md2.7 KiB
- references/publishing.md5.7 KiB
- references/script-extensions.md7.3 KiB
- references/ui-extensions.md20.7 KiB
- references/webhooks.md3.4 KiB
- references/workflow.md8.3 KiB
references/extension-types.md
Extension types
Extension types
Stripe Apps supports five extension types. Use the discovery interview in discovery.md to determine which one the user needs.
1. UI extension — “show something in the Dashboard”
Renders custom UI inside the Stripe Dashboard using the Stripe UI toolkit. Runs in a sandboxed iframe.
Plain-language examples:
“Show a customer’s loyalty points next to their Stripe profile”
“Add a button to send a custom invoice email”
“Build a full-screen analytics dashboard inside Stripe”
“Show a customer’s order history from my store next to their Stripe data”
What you can build:
Page-specific panels (next to a customer, payment, invoice, subscription, or product)
A side panel that appears everywhere in the Dashboard
A full-screen page inside the Dashboard
A setup/onboarding screen when users first install the app
An app settings page
Key constraints:
React 17 only (not 18+)
Only
@stripe/ui-extension-sdk/uicomponents — no Tailwind, HTML, or third-party UI librariesCan’t access
window,document, orlocalStorageMust use the SDK’s Stripe API client (see canonical docs for initialization pattern)
Read: ui-extensions.md, workflow.md
2. Backend-only app — “react to events, no Dashboard UI”
Runs on the developer’s server. Receives Stripe webhooks and calls the Stripe API. No Dashboard UI.
Plain-language examples:
“Email a download link after a payment”
“Sync purchases to a Google Sheet”
“Create an order in my fulfillment system when a payment succeeds”
“Notify my team on Slack when a new subscription starts”
How it works:
Your server receives Stripe events (webhooks)
Your server calls the Stripe API using platform keys (no manual key-sharing with merchants)
No UI — all logic runs server-side
Read: authentication.md, webhooks.md, backend.md, workflow.md
3. Full-stack app — “Dashboard UI + backend server”
Combines a UI extension with a backend server. The UI can show data from external services and trigger server-side actions.
Plain-language examples:
“Show my customer’s loyalty points in Stripe AND update them when they make a purchase”
“Let merchants configure their email templates from the Dashboard, then send emails from my server”
“Show real-time shipping status next to each payment”
How it works:
UI extension in the Dashboard for user interaction
Backend server for data storage, third-party API calls, and webhook processing
UI authenticates to the backend using
fetchStripeSignature
Read: all reference files
4. Extension interfaces — “plug into the Stripe billing or payments engine”
Lets your app change how Stripe processes billing or payments. Available types:
Billing extensions:
Custom discount calculation
Custom proration calculation
Custom customer balance handling
Custom recurring billing item handling
Payments orchestration:
Custom payment routing
Availability: Read the extension-point catalog and the selected interface’s product documentation. Use its current applicability, supported implementation types, and account access requirements. Don’t assume all interfaces are in private preview. Ask for access confirmation only if that interface requires it and access hasn’t already been established.
5. Embedded apps — “embed a third-party Stripe App inside your platform” (private preview)
For Connect platforms that want to surface third-party Stripe Apps (like QuickBooks, Xero, or Mailchimp) directly inside their own product.
This is different from building an app. Embedded apps are for platforms that want to host existing apps, not for building new ones.
Private preview: If the user asks for this, point them to https://docs.stripe.com/stripe-apps/embedded-apps.
Full viewport routing table
For UI extensions — maps plain-language descriptions to viewport IDs:
| What the user wants | Viewport ID |
|---|---|
| Next to a specific customer | stripe.dashboard.customer.detail |
| On the customers list page | stripe.dashboard.customer.list |
| Next to a specific payment | stripe.dashboard.payment.detail |
| On the payments list page | stripe.dashboard.payment.list |
| Next to a specific invoice | stripe.dashboard.invoice.detail |
| On the invoices list page | stripe.dashboard.invoice.list |
| Next to a specific subscription | stripe.dashboard.subscription.detail |
| On the subscriptions list page | stripe.dashboard.subscription.list |
| Next to a specific product | stripe.dashboard.product.detail |
| On the products list page | stripe.dashboard.product.list |
| Everywhere in the Dashboard (side panel) | stripe.dashboard.drawer.default |
| As its own full-screen page | Full-page app — stripe.dashboard.fullpage |
| On the Dashboard homepage | stripe.dashboard.home.overview |
| App settings page | settings |
| First-run setup after install | onboarding |
For the full viewport reference, see https://docs.stripe.com/stripe-apps/reference/viewports.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Stripe
- Publisher
- Stripe (Official)
- Source
- stripe/ai · skills/stripe-apps · commit 38fa045
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Also distributed in
- stripe/ai, stripe/ai, stripe/ai, stripe/ai, stripe/ai
AutoGineer is not affiliated with or endorsed by Stripe or Stripe.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download stripe-apps.zip