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

# Stripe setup

ConfigView reads how your Stripe account is set up through the Stripe API (`https://api.stripe.com/v1`), using a **restricted API key** that you create in the Stripe Dashboard. ConfigView sends only `GET` requests. It never creates, changes or deletes anything in Stripe.

You will end up with **1 required secret** (`STRIPE_RESTRICTED_KEY`) in ConfigView when setup is complete.

> **Scope of this integration today.** This is a deliberately thin connector. ConfigView reads your account settings (country, default currency, whether charges and payouts are enabled, capability statuses, payout schedule, website host), your **webhook endpoints** (destination host, enabled or disabled, which event types, API version, live or test) and, if you run a Connect platform, your **connected accounts** (type, country, charges and payouts enabled, requirements due, disabled reason). It does **not** read payments, charges, customers, invoices, balances, payouts, bank accounts or events.

***

## What you need

* A Stripe user who can create restricted API keys (an Administrator on the account)
* Whether you are a Stripe Connect platform (this decides whether the Connect permission is useful)

***

## Step 1: Open the Stripe page in ConfigView

Open ConfigView in a second browser tab and leave it open:

`https://{companyname}.configview.com/admin/integrations/stripe`

***

## Step 2: Create a restricted key

1. In the Stripe Dashboard open **Developers > API keys** and choose **Create restricted key**
2. Name it `ConfigView (read only)`
3. Set permissions. Everything stays **None** except:

| Resource | Permission | Why |
| - | - | - |
| **Webhook Endpoints** | **Read** | Lists your webhook endpoints |
| **Connect** (connected accounts) | **Read** | Lists connected accounts. Connect platforms only; skip it if you are not a platform |

4. Create the key and copy it (it starts `rk_live_`). Stripe shows it once.
5. In the ConfigView tab paste it into `STRIPE_RESTRICTED_KEY` under **Credentials** and save

Never grant **Write** on anything. Do not use your full secret key (`sk_live_`): it can move money.

Reading your own account (`GET /v1/account`) needs no specific permission on a valid key.

***

## Step 3: Connect and verify

1. Click **Connect**. ConfigView creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Account settings** | One row: the account the key belongs to. |
| **Webhook endpoints** | Every endpoint, with host only and the event type names. |
| **Connected accounts** | Connect platforms only. A normal account returns zero rows, which is fine. |

2. Click **Verify now**. The health check reads the secret, retrieves the account, and tries one small request each for webhook endpoints and connected accounts.

If a check fails:

* **Account fails with 401.** The key was mistyped, revoked or expired.
* **Webhook endpoints or Connected accounts shows as skipped.** The key lacks that Read permission. Add it in Developers > API keys, or ignore it if you do not need that area.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run.

| Table | Source | Key Columns |
| - | - | - |
| `stripe_account` | `GET /v1/account` | account\_id, account\_type, country, default\_currency, charges\_enabled, payouts\_enabled, details\_submitted, capabilities, website\_host, payout\_interval, requirements\_due\_count, disabled\_reason |
| `stripe_webhook_endpoints` | `GET /v1/webhook_endpoints` | endpoint\_id, url\_host, url\_scheme, status, enabled\_events\_count, all\_events, enabled\_events, api\_version, application, livemode |
| `stripe_connected_accounts` | `GET /v1/accounts` | account\_id, account\_type, controller\_type, country, charges\_enabled, payouts\_enabled, details\_submitted, requirements\_due\_count, disabled\_reason |

***

## Things worth knowing

**Team members and API keys are not available.** Stripe has no API for the people on your Dashboard team, their roles, or your list of API keys. They can only be reviewed in the Dashboard (Settings > Team and Developers > API keys), so ConfigView cannot show them.

**Webhook URLs are cut to the host.** The path of a webhook URL can carry a secret token, so ConfigView keeps only the scheme and host. Signing secrets are never read.

**Test and live keys.** A live key (`rk_live_`) reads live mode; a test key reads test mode. Use the live key.

**Rate limits.** Stripe allows 100 requests a second live (25 a second per endpoint) and counts reads against a monthly allowance (500 reads per transaction, at least 10,000 a month). ConfigView makes a handful of requests per run, paced at 60 a minute, and waits as long as Stripe asks on a 429.

## What isn't collected

* Charges, payment intents, customers, invoices, subscriptions, refunds, disputes and any amounts
* Balance, payouts and bank accounts
* The account email, support contact details, business names and tax ids
* The full webhook URL, webhook description and metadata
* Events (they carry payment contents)


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