> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Stripe (API Key)

> Integrate your application with the Stripe API using API keys

## 🚀 Quickstart

Connect to Stripe with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Stripe (API Key)*.
  </Step>

  <Step title="Authorize Stripe">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then enter your Stripe secret API key. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the Stripe API">
    Let's make your first request to the Stripe API (retrieve account balance). Replace the placeholders below with your [Environment API key](/docs/reference/backend/http-api/api-keys), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/v1/balance" \
          -H "Authorization: Bearer <NANGO-API-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

        const res = await nango.get({
            endpoint: '/v1/balance',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/docs/reference/backend/backend-sdk/node#get-a-connection-with-credentials) or [API](/docs/reference/backend/http-api/connections/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/docs/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Stripe Integration Guides

Nango-maintained guides for common use cases.

* [How to obtain your Stripe API key](/docs/api-integrations/stripe-api-key/connect)\
  Get your Stripe secret API key to connect it to Nango

Official docs: [Stripe API Documentation](http://docs.stripe.com/)

## 🧩 Pre-built syncs & actions for Stripe (API Key)

Explore Nango-provided actions in your dashboard. Extend and customize them to fit your needs.

### Others

| Function name | Description | Type | Source code |
| - | - | - | - |
| `cancel-payment-intent` | Cancel a Stripe PaymentIntent. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/cancel-payment-intent.ts) |
| `capture-payment-intent` | Capture an uncaptured Stripe PaymentIntent. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/capture-payment-intent.ts) |
| `create-checkout-session` | Create a checkout session in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-checkout-session.ts) |
| `create-credit-note` | Create a credit note in Stripe to adjust or refund a finalized invoice. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-credit-note.ts) |
| `create-customer` | Create a customer in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-customer.ts) |
| `create-invoice-item` | Create an invoice item in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-invoice-item.ts) |
| `create-invoice` | Create an invoice in Stripe | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-invoice.ts) |
| `create-payment-intent` | Create a payment intent in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-payment-intent.ts) |
| `create-payment-method` | Create a payment method in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-payment-method.ts) |
| `create-price` | Create a price in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-price.ts) |
| `create-product` | Create a product in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-product.ts) |
| `create-refund` | Create a refund in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-refund.ts) |
| `create-setup-intent` | Create a setup intent in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-setup-intent.ts) |
| `create-subscription` | Create a subscription in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/create-subscription.ts) |
| `delete-customer` | Delete or archive a customer in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-customer.ts) |
| `delete-invoice-item` | Delete an invoice item from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-invoice-item.ts) |
| `delete-invoice` | Delete or archive a invoice in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-invoice.ts) |
| `delete-payment-intent` | Cancel a Stripe PaymentIntent. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-payment-intent.ts) |
| `delete-price` | Archive a price in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-price.ts) |
| `delete-product` | Delete or archive a product in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-product.ts) |
| `delete-setup-intent` | Delete or archive a setup intent in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-setup-intent.ts) |
| `delete-subscription` | Delete or archive a subscription in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/delete-subscription.ts) |
| `finalize-invoice` | Finalize a draft Stripe invoice. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/finalize-invoice.ts) |
| `get-checkout-session` | Retrieve a single checkout session from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-checkout-session.ts) |
| `get-credit-note` | Retrieve a single credit note from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-credit-note.ts) |
| `get-customer` | Retrieve a single customer from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-customer.ts) |
| `get-invoice-item` | Retrieve a single invoice item from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-invoice-item.ts) |
| `get-invoice` | Retrieve a single invoice from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-invoice.ts) |
| `get-payment-intent` | Retrieve a single payment intent from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-payment-intent.ts) |
| `get-payment-method` | Retrieve a single payment method from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-payment-method.ts) |
| `get-price` | Retrieve a single price from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-price.ts) |
| `get-product` | Retrieve a single product from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-product.ts) |
| `get-refund` | Retrieve a single refund from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-refund.ts) |
| `get-setup-intent` | Retrieve a single setup intent from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-setup-intent.ts) |
| `get-subscription` | Retrieve a single subscription from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/get-subscription.ts) |
| `list-checkout-sessions` | List checkout sessions from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-checkout-sessions.ts) |
| `list-credit-notes` | List credit notes from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-credit-notes.ts) |
| `list-customers` | List customers from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-customers.ts) |
| `list-invoice-items` | List invoice items from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-invoice-items.ts) |
| `list-invoices` | List invoices from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-invoices.ts) |
| `list-payment-intents` | List payment intents from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-payment-intents.ts) |
| `list-payment-methods` | List payment methods from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-payment-methods.ts) |
| `list-prices` | List prices from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-prices.ts) |
| `list-products` | List products from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-products.ts) |
| `list-refunds` | List refunds from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-refunds.ts) |
| `list-setup-intents` | List setup intents from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-setup-intents.ts) |
| `list-subscriptions` | List subscriptions from Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/list-subscriptions.ts) |
| `pay-invoice` | Pay a Stripe invoice. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/pay-invoice.ts) |
| `update-customer` | Update a customer in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-customer.ts) |
| `update-invoice-item` | Update an invoice item in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-invoice-item.ts) |
| `update-invoice` | Update an invoice in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-invoice.ts) |
| `update-payment-intent` | Update a payment intent in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-payment-intent.ts) |
| `update-price` | Update a price in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-price.ts) |
| `update-product` | Update a product in Stripe | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-product.ts) |
| `update-refund` | Update a refund in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-refund.ts) |
| `update-setup-intent` | Update a setup intent in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-setup-intent.ts) |
| `update-subscription` | Update a subscription in Stripe. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/update-subscription.ts) |
| `void-credit-note` | Void a Stripe credit note. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/void-credit-note.ts) |
| `void-invoice` | Void a Stripe invoice. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/actions/void-invoice.ts) |
| `checkout-sessions` | Sync checkout sessions from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/checkout-sessions.ts) |
| `credit-notes` | Sync credit notes from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/credit-notes.ts) |
| `customers` | Sync customers from Stripe. Incrementally fetches newly created customers using a creation-time checkpoint. Updates to existing customers are not captured; use a customer-events sync for update tracking. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/customers.ts) |
| `invoice-items` | Sync invoice items from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/invoice-items.ts) |
| `invoices` | Sync invoices from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/invoices.ts) |
| `payment-intents` | Sync payment intents from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/payment-intents.ts) |
| `payment-methods` | Sync payment methods from Stripe | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/payment-methods.ts) |
| `prices` | Sync prices from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/prices.ts) |
| `products` | Sync products from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/products.ts) |
| `refunds` | Sync refunds from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/refunds.ts) |
| `setup-intents` | Sync setup intents from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/setup-intents.ts) |
| `subscriptions` | Sync subscriptions from Stripe. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/stripe/syncs/subscriptions.ts) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.