⚡Stripe API Quickstart

Base URL: https://api.stripe.com/v1/ (HTTPS required)

Auth: HTTP Basic Auth – Username: your sk_…, leave password blank

Connect: Add header: Stripe-Account: acct_…

RAK/OAuth: Restricted API Keys or OAuth tokens for marketplaces

Stripe.com API Features

Topic Endpoint / Params Function Features Benefits Auth
Authentication Secures all API calls • sk_test…/sk_live… keys
• Restricted keys
• Instant Test↔Live switch
• Granular permissions
Uniform security
Flexible key rotation
HTTP Basic w/ Secret Key
Error Handling Consistent error model • HTTP status codes (2xx/4xx/5xx)
• error.code / message
• Clear client vs server
Programmable retries
Clean UX on failure
HTTP Basic w/ Secret Key
Expand ?expand[]=… Inline embed linked objects • Up to 4 levels deep
• Multiple fields per request
Fewer round trips
Simpler client logic
HTTP Basic w/ Secret Key
Idempotency Idempotency-Key header Safe retries, no duplicates • 24h storage
• Automatic dedupe
• Retry strategies
Prevents double charges HTTP Basic w/ Secret Key
Metadata metadata[key]=value Attach custom key/value • Up to 50 pairs
• Values up to 500 chars
Flexible tracking
Audit trails
HTTP Basic w/ Secret Key
Pagination limit, starting_after, ending_before Cursor-based lists • Cursor instead of page#
• Auto-pagination in SDKs
Efficient data handling HTTP Basic w/ Secret Key
Search /v1/.../search + query, page, limit Full-text & filter queries • SQL-like syntax
• next_page cursor
Complex queries natively HTTP Basic w/ Secret Key
Versioning / Req-ID Stripe-Version header, Request-Id Lock API version & debug • Monthly backward-compatible releases
• Unique request IDs
Stable upgrades
Faster support
HTTP Basic w/ Secret Key

Core Payments APIs

Topic Endpoint / Params Function Features Benefits Auth
PaymentIntents /v1/payment_intents
/:id/confirm
/:id/capture
/:id/cancel
Manage full payment flows • PSD2 compliant
• 3DS flows built-in
• Auto status transitions
Unified API for all methods API Key
Charges /v1/charges
/:id
/:id/capture
Legacy direct charges • Immediate capture
• Multiple captures
Simple & direct integration API Key
Checkout Sessions /v1/checkout/sessions
/:id/line_items
Hosted checkout UI • Dynamic payment methods
• A/B testing
• CSS theming
High conversions
No UI code needed
API Key
Payment Links /v1/payment_links
/:id/line_items
No-code payment URLs • Reusable links
• Price/product config
Quick start, no dev API Key
SetupIntents /v1/setup_intents
/:id/confirm
/:id/cancel
Save payment methods • Auto-attach to customer
• Micro-deposit support
Smooth future payments API Key
PaymentMethods /v1/payment_methods
/:id
/:id/attach
/:id/detach
Manage payment instruments • Cards, SEPA, wallets…
• Customer-scoped
Improved UX API Key
Webhooks & Events /v1/webhook_endpoints
/v1/events
Async event handling • Signature verification
• Retries & replay
• Real-time triggers
Reliable automation API Key + Webhook Secret

Billing & Subscriptions

Topic Endpoint / Params Function Features Benefits Auth
Subscriptions /v1/subscriptions
/:id
/:id/cancel
/:id/resume
/search
Manage recurring billing • Usage & quantity based
• Trials
• Prorations
Predictable revenue
Flexible pricing
API Key
Invoices /v1/invoices
/:id
/create_preview
/:id/finalize
/:id/send
/search
Create & send invoices • Email delivery
• PDF rendering
• Reminder workflows
Automated dunning
Professional branding
API Key
Billing Payment Links /v1/payment_links
/:id/line_items
No-code billing links • Reusable
• A/B testing
Fastest go-live API Key
Tax /v1/tax/rates
/v1/tax/calculations
/v1/tax/registrations
Automated tax calculation • Country rules
• Threshold monitoring
• Reporting
Reduced error risk
Less manual work
API Key
Revenue Recognition /v1/reporting/report_runs
(recognized_revenue_summary_by_product)
ASC 606 automation • Real-time status
• Product/date categories
Compliance assurance
Less bookkeeping
Reporting Key / Dashboard
Payout Reconciliation /v1/reporting/report_runs
(itemized_payouts)
Match payouts to bank • Detailed payout line-items
• Status flags
Automated control
Faster close
API Key
Sigma (Custom Reports) /v1/sigma/scheduled_query_runs
/:id
SQL-based reporting • Scheduled runs
• Output files
• Webhook notifications
Deep real-time insights API Key
Data Pipeline – (Dashboard export) Warehouse export • Full history
• Auto updates
BI integration
Central warehouse
Dashboard Login
External Data Import – (No-code connector) Auto data import • CSV, SFTP, API
• Mapping UI
Unified dataset
Less ETL work
Dashboard Login
Atlas (Incorporation) – (Atlas dashboard) Company formation & EIN • LLC/C-Corp options
• 83(b) support
• Founders bundle
Complete incorporation
Founder discounts
Atlas Login

Connect & Marketplaces

Topic Endpoint / Params Function Features Benefits Auth
Auth & Scope Access & account scoping • Stripe-Account header
• Context switching
Single key management HTTP Basic + Account Header
Hosted Onboarding /v1/account_links Prebuilt onboarding flow • Standard UI
• Auto verification
Fastest integration API Key + Account Header
Embedded Onboarding Connect Components (JS/React) Custom UI widgets • Custom branding
• Unified UX
• Flexible config
Self-hosted UX API Key + Account Header
API Onboarding /v1/accounts
/:id/persons
Full custom flow • Fine-grained data
• Own UX
Maximum flexibility API Key + Account Header
Direct Charges POST /v1/charges + Account Header Charge directly on connect • Immediate funds
• Full fee control
Clear revenue split API Key + Account Header
Destination Charges POST /v1/charges + destination={acct_…} Platform charges then payout • Platform fee
• Split remainder
Fee monetization
Transparency
API Key + Account Header
Separate Charges & Transfers POST /v1/charges
POST /v1/transfers
Two-step payment flow • Timing flexibility
• Partial splits
Delayed/batched payouts API Key + Account Header
Subscriptions (Connected) POST /v1/subscriptions + Account Header Recurring for sellers • Usage & flat plans
• Trials & prorations
Automated seller billing API Key + Account Header
Payouts GET/POST /v1/payouts + Account Header Payout funds to accounts • Schedule options
• Reversals/cancels
Automated payouts API Key + Account Header
Tax & Reporting /v1/tax/calculations + Account Header
/v1/reporting/report_runs
Tax & 1099 reporting • Threshold monitoring
• Form generation
Compliance automation API Key + Account Header
Radar – (Dashboard rules) Fraud prevention & scoring • Platform-wide rules
• Real-time scoring
Fewer frauds
Unified policy
Dashboard Login + API Key
Dashboard Components Embedded Components Seller UI widgets • Balances, Transactions, Reports
• Full UI kit
Seller self-service API Key + Account Header
Global Currencies Worldwide payments & payouts • 135+ currencies
• Local methods
• Cross-border
Higher conversions API Key + Account Header
Platform Tools – (Dashboard: team, roles) Central platform mgmt • Multi-user roles
• Event logging
• Webhook config
Scalable permissions Dashboard Login + API Key

Issuing, Treasury & Capital

Topic Endpoint / Params Function Features Benefits Auth
Issuing /v1/issuing/cardholders
/v1/issuing/cards
/v1/issuing/authorizations/:id
/v1/issuing/disputes
Create & manage cards • Physical & virtual
• Auth & capture controls
• PIN/magstripe
• Dispute handling
Real-time expense control API Key
Treasury /v1/treasury/financial_accounts
/v1/treasury/transactions
/v1/treasury/transaction_entries
/v1/treasury/inbound_transfers
/v1/treasury/outbound_transfers
Banking-as-a-Service • Multi-currency accounts
• ACH/Wire flows
• Real-time balances
Seamless cash mgmt API Key
Capital /v1/capital/financing_offers
/:id/mark_delivered
/v1/capital/financing_summary
Revenue-based financing • % revenue repayment
• Offer lifecycle
• Status dashboard
Fast capital access
No interest loans
API Key
Connect Capital Same endpoints + Account Header Platform financing offers • Platform-driven offers
• API onboarding & monitoring
Unified mgmt for platform & sellers API Key + Account Header

Developer Tools & Infrastructure

Topic Tool / Endpoint Function Features Benefits Auth
Versioning & Changelog Track API changes • Monthly releases
• Breaking-change notes
• Dashboard changelog
Early break alerts Stripe-Version header
SDKs & UI Components Official client libraries Fast integration • Auto-pagination
• Typed interfaces
• UI elements
Less boilerplate API Key
Error Management Auth & robust errors • HTTP Basic auth
• Standard error objects
• Idempotency tools
Safe retries HTTP Basic w/ Secret Key
Testing & Sandbox Test clocks, helpers, simulators Realistic tests • Time travel
• Webhook forwarding
• Test fixtures
Complex flows safely Test-Mode API Key
Event Destinations /v2/core/event_destinations Route events externally • Thin vs snapshot
• Ping/enable/disable
Flexible routing API Key
Stripe CLI stripe commands Local resource mgmt • Fixture generation
• Webhook forwarding
• Live-mode simulate
Rapid prototyping CLI login
Workbench Dashboard UI Query & debug • Query explorer
• Event log
• API version tests
Central troubleshooting Dashboard login
Stripe Shell In-browser CLI Interactive testing • Autocomplete
• In-context samples
No local setup Dashboard login
Developer Dashboard Dashboard UI Monitor calls & webhooks • Live logs
• Request details
• Quota watch
Real-time insight Dashboard login
LLM Integration LLMS.txt, API playground AI-assisted workflows • Prompt templates
• Auto docs fetch
Faster prototyping API Key
Security Best Practices Key & infra protection • Webhook signature
• Key rotation
• RBAC
Minimized risk API Key + Webhook Secret
Apps & Connectors /v1/apps, Connectors UI Dashboard extensions • UI extensions
• OAuth flows
• Templates
Custom workflows API Key + OAuth
Partner Ecosystem Training & community • Partner directory
• Certification
• Tutorials/Discord
Expert network Partner portal
Source: All content derived from Stripe API documentation.