Stripe App - Nango Docs

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
Expired credentials detection	✅

✅ Read & write data

Tools	Status
Pre-built integrations	🚫 (time to contribute: <48h)
API unification	✅
2-way sync	✅
Webhooks from Nango on data modifications	✅
Real-time webhooks from 3rd-party API	🚫 (time to contribute: <48h)
Proxy requests	✅

✅ Observability & data quality

Tools	Status
HTTP request logging	✅
End-to-end type safety	✅
Data runtime validation	✅
OpenTelemetry export	✅
Slack alerts on errors	✅
Integration status API	✅

✅ Customization

Tools	Status
Create or customize use-cases	✅
Pre-configured pagination	🚫 (time to contribute: <48h)
Pre-configured rate-limit handling	🚫 (time to contribute: <48h)
Per-customer configurations	✅

No pre-built syncs or actions available yet.

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

Create a Stripe account

If you don’t already have one, sign up for a Stripe account.

Install Stripe CLI

If you haven’t already, install the Stripe CLI.
Log in using your Stripe account:
stripe login

Install the Stripe Apps CLI plugin

Run the following command to install the Stripe Apps plugin:
stripe plugin install apps
Verify the plugin version is 1.5.12 or newer:
stripe apps -v

Create your Stripe App

Create a new app project using the CLI:
stripe apps create my-stripe-app
This creates a local project folder with a manifest and app code.

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:

{
  "id": "com.example.my-app",
  "version": "0.0.1",
  "name": "My Stripe App",
  "icon": "./icon.png",
  "permissions": [],
  "stripe_api_access_type": "oauth",
  "distribution_type": "public",
  "allowed_redirect_uris": [
    "https://api.nango.dev/oauth/callback"
  ]
}

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.).

"permissions": [
    {
        "permission": "customer_read",
        "purpose": "Receive access to the customer’s phone number"
    }
]

Optionally add a settings view or other UI extensions if your app has a user-facing configuration.

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:
stripe apps upload

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.

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 either the Live mode or Test mode link (e.g., client_id=…). Use the link for whichever mode you’d like to test or deploy.
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.

Follow the Quickstart.

Need help getting started? Get help in the community.

Useful links

Topic	Links
General	Stripe Dashboard
	Stripe Documentation
Developer	Stripe Apps Overview
	Stripe Apps CLI Guide
	OAuth for Stripe Apps
	Oauth App scopes
	App Manifest Reference
	Testing Your Stripe App
	App Marketplace Publishing Guide
	OAuth Token Exchange

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

​Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

​Pre-built tooling

​Setup guide

​Useful links

​Common Scopes

​API gotchas

Overview

Pre-built tooling

Setup guide

Useful links

Common Scopes

API gotchas