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

# Stripe

## What's supported

### Supported actions

The Stripe connector supports:

* [Read Actions](/read-actions), including full historic backfill. A full read of the Stripe instance will be done for each scheduled read. Please note that incremental read is supported for several object, see below.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.stripe.com`.

### Supported Objects

The Stripe connector supports reading from and writing to the following objects:

* [accounts](https://docs.stripe.com/api/accounts/object) (incremental read supported)
* apple\_pay/domains (Apple Pay Domains)
* [billing/alerts](https://docs.stripe.com/api/billing/alert/object)
* [billing/credit\_grants](https://docs.stripe.com/api/billing/credit-grant/object)
* [billing/meters](https://docs.stripe.com/api/billing/meter/object)
* [billing\_portal/configurations](https://docs.stripe.com/api/customer_portal/configurations/object)
* [charges](https://docs.stripe.com/api/charges/object) (incremental read supported)
* [checkout/sessions](https://docs.stripe.com/api/checkout/sessions/object) (incremental read supported)
* [climate/orders](https://docs.stripe.com/api/climate/order/object)
* [coupons](https://docs.stripe.com/api/coupons/object) (incremental read supported)
* [credit\_notes](https://docs.stripe.com/api/credit_notes/object) (incremental read supported)
* [customers](https://docs.stripe.com/api/customers/object) (incremental read supported)
* [disputes](https://docs.stripe.com/api/disputes/object) (incremental read supported)
* [entitlements/features](https://docs.stripe.com/api/entitlements/feature/object)
* [file\_links](https://docs.stripe.com/api/file_links/object) (incremental read supported)
* [files](https://docs.stripe.com/api/files/object) (incremental read supported)
* [forwarding/requests](https://docs.stripe.com/api/forwarding/request/object) (incremental read supported)
* [identity/verification\_sessions](https://docs.stripe.com/api/identity/verification_sessions/object) (incremental read supported)
* [invoiceitems](https://docs.stripe.com/api/invoiceitems/object) (incremental read supported)
* [invoices](https://docs.stripe.com/api/invoices/object) (incremental read supported)
* [issuing/authorizations](https://docs.stripe.com/api/issuing/authorizations/object) (incremental read supported)
* [issuing/cardholders](https://docs.stripe.com/api/issuing/cardholders/object) (incremental read supported)
* [issuing/cards](https://docs.stripe.com/api/issuing/cards/object) (incremental read supported)
* [issuing/disputes](https://docs.stripe.com/api/issuing/disputes/object) (incremental read supported)
* [issuing/personalization\_designs](https://docs.stripe.com/api/issuing/personalization_designs/object)
* [issuing/transactions](https://docs.stripe.com/api/issuing/transactions/object) (incremental read supported)
* [payment\_intents](https://docs.stripe.com/api/payment_intents/object) (incremental read supported)
* [payment\_links](https://docs.stripe.com/api/payment-link/object)
* [payment\_method\_configurations](https://docs.stripe.com/api/payment_method_configurations/object)
* [payment\_method\_domains](https://docs.stripe.com/api/payment_method_domains/object)
* [payment\_methods](https://docs.stripe.com/api/payment_methods/object)
* [payouts](https://docs.stripe.com/api/payouts/object) (incremental read supported)
* [plans](https://docs.stripe.com/api/plans/object) (incremental read supported)
* [prices](https://docs.stripe.com/api/prices/object) (incremental read supported)
* [products](https://docs.stripe.com/api/product-feature/object) (incremental read supported)
* [promotion\_codes](https://docs.stripe.com/api/promotion_codes/object) (incremental read supported)
* [quotes](https://docs.stripe.com/api/quotes/object)
* [radar/value\_lists](https://docs.stripe.com/api/radar/value_lists/object) (incremental read supported)
* [refunds](https://docs.stripe.com/api/refunds/object) (incremental read supported)
* [reporting/report\_runs](https://docs.stripe.com/api/reporting/report_run/object) (incremental read supported)
* [setup\_intents](https://docs.stripe.com/api/setup_intents/object) (incremental read supported)
* [shipping\_rates](https://docs.stripe.com/api/shipping_rates/object) (incremental read supported)
* [subscription\_schedules](https://docs.stripe.com/api/subscription_schedules/object) (incremental read supported)
* [subscriptions](https://docs.stripe.com/api/subscriptions/object) (incremental read supported)
* [tax/registrations](https://docs.stripe.com/api/tax/registrations/object)
* [tax\_ids](https://docs.stripe.com/api/tax_ids/object)
* [tax\_rates](https://docs.stripe.com/api/tax_rates/object) (incremental read supported)
* [terminal/configurations](https://docs.stripe.com/api/terminal/configuration/object)
* [terminal/locations](https://docs.stripe.com/api/terminal/locations/object)
* [terminal/readers](https://docs.stripe.com/api/terminal/readers/object)
* [test\_helpers/test\_clocks](https://docs.stripe.com/api/test_clocks/object)
* [topups](https://docs.stripe.com/api/topups/object) (incremental read supported)
* [transfers](https://docs.stripe.com/api/transfers/object) (incremental read supported)
* [treasury/financial\_accounts](https://docs.stripe.com/api/treasury/financial_accounts/object) (incremental read supported)
* [webhook\_endpoints](https://docs.stripe.com/api/webhook_endpoints/object)

The Stripe connector supports only read actions on the following objects:

* [application\_fees](https://docs.stripe.com/api/application_fees/object) (incremental read supported)
* [balance\_transactions](https://docs.stripe.com/api/balance_transactions/object) (incremental read supported)
* [climate/products](https://docs.stripe.com/api/climate/product/object)
* [climate/suppliers](https://docs.stripe.com/api/climate/supplier/object)
* [country\_specs](https://docs.stripe.com/api/country_specs/object)
* [events](https://docs.stripe.com/api/events/object) (incremental read supported)
* [financial\_connections/accounts](https://docs.stripe.com/api/financial_connections/accounts/object)
* balance/history (Transaction history for balance changes) (incremental read supported)
* [identity/verification\_reports](https://docs.stripe.com/api/identity/verification_reports/object) (incremental read supported)
* [invoice\_rendering\_templates](https://docs.stripe.com/api/invoice-rendering-template/object)
* [issuing/physical\_bundles](https://docs.stripe.com/api/issuing/physical_bundles/object)
* [radar/early\_fraud\_warnings](https://docs.stripe.com/api/radar/early_fraud_warnings/object) (incremental read supported)
* [reporting/report\_types](https://docs.stripe.com/api/reporting/report_type/object)
* [reviews](https://docs.stripe.com/api/radar/reviews/object) (incremental read supported)
* [sigma/scheduled\_query\_runs](https://docs.stripe.com/api/sigma/scheduled_queries/object)
* [tax\_codes](https://docs.stripe.com/api/tax_codes/object)

The Stripe connector supports only write actions on the following objects:

* [account\_links](https://docs.stripe.com/api/account_links/object)
* [account\_sessions](https://docs.stripe.com/api/account_sessions/object)
* [apps/secrets](https://docs.stripe.com/api/apps/secret_store/secret_resource)
* [billing/meter\_event\_adjustments](https://docs.stripe.com/api/billing/meter-event-adjustment/object)
* [billing/meter\_events](https://docs.stripe.com/api/billing/meter-event/object)
* [billing\_portal/sessions](https://docs.stripe.com/api/customer_portal/sessions/object)
* [customer\_sessions](https://docs.stripe.com/api/customer_sessions/object)
* ephemeral\_keys (Creates a short-lived API key for a given resource)
* [financial\_connections/sessions](https://docs.stripe.com/api/financial_connections/sessions/object)
* [invoices/create\_preview](https://docs.stripe.com/api/invoices/create_preview)
* issuing/settlements (Updates the specified Issuing Settlement object)
* [issuing/tokens](https://docs.stripe.com/api/issuing/tokens/object)
* [issuing/tokens](https://docs.stripe.com/api/issuing/tokens/object)
* [radar/value\_list\_items](https://docs.stripe.com/api/radar/value_list_items/object)
* [sources](https://docs.stripe.com/api/sources/object)
* [subscription\_items](https://docs.stripe.com/api/subscription_items/object)
* [tax/calculations](https://docs.stripe.com/api/tax/calculations/object)
* [tax/settings](https://docs.stripe.com/api/tax/settings/object)
* [terminal/connection\_tokens](https://docs.stripe.com/api/terminal/connection_tokens/object)
* [test\_helpers/confirmation\_tokens](https://docs.stripe.com/api/confirmation_tokens/object)
* [test\_helpers/issuing/authorizations](https://docs.stripe.com/api/issuing/authorizations/test_mode_create)
* test\_helpers/issuing/settlements (Create an Issuing settlement)
* [test\_helpers/treasury/outbound\_payments](https://docs.stripe.com/api/treasury/outbound_payments/test_mode_update)
* [test\_helpers/treasury/outbound\_transfers](https://docs.stripe.com/api/treasury/outbound_transfers/test_mode_update)
* [test\_helpers/treasury/received\_credits](https://docs.stripe.com/api/treasury/received_credits/object)
* [test\_helpers/treasury/received\_debits](https://docs.stripe.com/api/treasury/received_debits/object)
* [treasury/credit\_reversals](https://docs.stripe.com/api/treasury/credit_reversals/object)
* [treasury/debit\_reversals](https://docs.stripe.com/api/treasury/debit_reversals/object)
* [treasury/inbound\_transfers](https://docs.stripe.com/api/treasury/inbound_transfers/object)
* [treasury/outbound\_payments](https://docs.stripe.com/api/treasury/outbound_payments/object)
* [treasury/outbound\_transfers](https://docs.stripe.com/api/treasury/outbound_transfers/object)

### Example integration

For an example manifest file of a Stripe integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/stripe/amp.yaml).

## Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Stripe:

* Create a manifest file like the [example](https://github.com/amp-labs/samples/blob/main/stripe/amp.yaml).
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.

## Creating an API key for Stripe

[Click here](https://docs.stripe.com/keys) for more information about generating an API key for Stripe. The UI components will display this link, so that your users can successfully create API keys.