APIs & Integrations
Stripe App
Overview
Pre-built tooling
Pre-built integrations
Not seeing the integration you need? Build your own independently.
Pre-Requisites | Status | Comment |
---|---|---|
Paid dev account | ✅ | You must have an activated Stripe account (submit business info). No charges required, but activation is mandatory. |
Paid test account | ✅ | Stripe does not require or support a paid test account. Sandbox accounts are available by default in every account. |
Partnership | ✅ | Not required to develop or publish apps, but Stripe may offer partnership options for higher visibility. |
App review | ❌ | Required if you want to publish the app publicly on the Stripe App Marketplace. Stripe will review your app before approval. |
Security audit | ✅ | Not strictly required, but apps must follow Stripe’s security best practices. A formal audit may be needed depending on your app’s access level and data usage. |
Setup guide
1
Create a Stripe account
If you don’t already have one, sign up for a Stripe account.
2
Install Stripe CLI
- If you haven’t already, install the Stripe CLI.
- Log in using your Stripe account:
3
Install the Stripe Apps CLI plugin
- Run the following command to install the Stripe Apps plugin:
- Verify the plugin version is 1.5.12 or newer:
4
Create your Stripe App
- Create a new app project using the CLI:
- This creates a local project folder with a manifest and app code.
5
Edit the app manifest
Open the stripe-app.json file and update these fields:
- stripe_api_access_type: Set to oauth
- distribution_type: Set to public
- allowed_redirect_uris: Add your redirect URI as https://api.nango.dev/oauth/callback. Example:
6
Add required permissions and UI (optional)
- Add permissions your app requires to access Stripe resources in the manifest (e.g., read_only, customers:read, etc.).
- Optionally add a settings view or other UI extensions if your app has a user-facing configuration.
7
Upload your app to Stripe (requires live account)
- Ensure you’re logged into a fully activated (non-sandbox) Stripe account.
- Upload your app to Stripe:
8
Publish your app
- Submit your app for review when you’re ready to publish it to the Stripe App Marketplace.
- When submitting an OAuth app, you must provide a Marketplace install URL. This URL should point to a page that initiates onboarding and installation, and clearly uses the OAuth install links found in the Settings tab of your app.
The public OAuth install links from the Settings tab are different from those in the External test tab and must be used for review and production installs. Even though these links are inactive until the app is published, the Stripe App Review team can still use them to install and test your app.
9
Obtain your Client ID and Client Secret
- Go to your app’s Settings tab in the Stripe Dashboard.
- Locate the Live mode link under the Install link section. The Client ID is included as a query parameter in this URL (e.g., client_id=…).
- To obtain your Client Secret, go to the API Keys page in the Stripe Dashboard and copy your Secret key (starts with
sk_live_…
). Save these credentials securely as you’ll need them when configuring your integration in Nango.
10
Next
Follow the Quickstart.
Need help getting started? Get help in the community.
Useful links
Contribute useful links by editing this page
Common Scopes
Permission | Description |
---|---|
payment_intent_read / payment_intent_write | Manage payment flows |
customer_read / customer_write | Manage customer data |
subscription_read / subscription_write | Manage recurring billing |
invoice_read / invoice_write | Manage invoices |
charge_read / charge_write | Process payments |
account_read | View connected accounts |
webhook_read | Manage webhooks |
file_read / file_write | Access uploaded files |
API gotchas
- The Stripe App is your live production integration, available for installation by real Stripe users. Use this when you’re ready to launch your app in a production environment.
Contribute API gotchas by editing this page