Stripe
What’s supported
Supported actions
The Stripe connector supports:
- Read Actions, including full historic backfill. Please note that incremental read is not supported, a full read of the Stripe instance will be done for each scheduled read.
- Write 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
- apple_pay/domains (Apple Pay Domains)
- billing/alerts
- billing/credit_grants
- billing/meters
- billing_portal/configurations
- charges
- checkout/sessions
- climate/orders
- coupons
- credit_notes
- customers
- entitlements/features
- file_links
- files
- forwarding/requests
- identity/verification_sessions
- invoiceitems
- invoices
- issuing/authorizations
- issuing/cardholders
- issuing/cards
- issuing/disputes
- issuing/disputes
- issuing/personalization_designs
- issuing/transactions
- payment_intents
- payment_links
- payment_method_configurations
- payment_method_domains
- payment_methods
- payouts
- plans
- prices
- products
- promotion_codes
- quotes
- radar/value_lists
- refunds
- reporting/report_runs
- setup_intents
- shipping_rates
- subscription_schedules
- subscriptions
- tax/registrations
- tax_ids
- tax_rates
- terminal/configurations
- terminal/locations
- terminal/readers
- test_helpers/test_clocks
- topups
- transfers
- treasury/financial_accounts
- webhook_endpoints
The Stripe connector supports only read actions on the following objects:
- application_fees
- balance_transactions
- climate/products
- climate/suppliers
- country_specs
- events
- financial_connections/accounts
- balance/history (Transaction history for balance changes)
- identity/verification_reports
- invoice_rendering_templates
- issuing/physical_bundles
- radar/early_fraud_warnings
- reporting/report_types
- reviews
- sigma/scheduled_query_runs
- tax_codes
The Stripe connector supports only write actions on the following objects:
- account_links
- account_sessions
- apps/secrets
- billing/meter_event_adjustments
- billing/meter_events
- billing_portal/sessions
- customer_sessions
- ephemeral_keys (Creates a short-lived API key for a given resource)
- financial_connections/sessions
- invoices/create_preview
- issuing/settlements (Updates the specified Issuing Settlement object)
- issuing/tokens
- issuing/tokens
- radar/value_list_items
- sources
- subscription_items
- tax/calculations
- tax/settings
- terminal/connection_tokens
- test_helpers/confirmation_tokens
- test_helpers/issuing/authorizations
- test_helpers/issuing/settlements (Create an Issuing settlement)
- test_helpers/treasury/outbound_payments
- test_helpers/treasury/outbound_transfers
- test_helpers/treasury/received_credits
- test_helpers/treasury/received_debits
- treasury/credit_reversals
- treasury/debit_reversals
- treasury/inbound_transfers
- treasury/outbound_payments
- treasury/outbound_transfers
Example integration
For an example manifest file of a Stripe integration, visit our samples repo on Github.
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.
- Deploy it using the amp CLI.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls.
Creating an API key for Stripe
Click here 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.