Stripe Documentation
Available Resources
Docs
Testing: Simulate payments to test your integration.
API Reference
Receive payouts: Set up your bank account to receive payouts.
Platforms and marketplaces with Stripe Connect: Build a SaaS platform or marketplace with Connect.
Supported currencies: Learn which currencies Stripe supports for payments and bank payouts.
API upgrades: Keep track of changes and upgrades to the Stripe API.
Stripe SDKs: Libraries and tools for interacting with your Stripe integration.
Receive Stripe events in your webhook endpoint: Listen for events from Stripe on your webhook endpoint so your integration can automatically trigger reactions.
Declines: Learn about payment declines and how to lower your decline rate.
Refund and cancel payments: Learn how to cancel or refund a payment.
Security at Stripe: Learn how Stripe handles security.
Build a Stripe-hosted checkout page
Build an advanced integration
Build a pre-built subscription page with Stripe Checkout
Set up and deploy a webhook: Learn how to set up and deploy a webhook to listen to events from Stripe.
Types of events
Integration security guide: Ensure PCI compliance and secure customer-server communications.
Payments analytics: Learn about the performance of your payments using key metrics and reports.
Integrate with events: Send events from Stripe to webhook endpoints and cloud services.
Resolve webhook signature verification errors: Learn how to fix a common error when listening to webhook events.
Start a team: Learn how to invite and interact with team members.
Errors
Versioning
Payment Methods
Payment Methods API: Learn more about the API that powers a range of global payment methods.
Linked external accounts: Manage your linked external accounts.
Bank Debits: Learn how to accept bank debits with Stripe.
How cards work: Learn how an online credit or debit card payment works.
Cartes Bancaires (CB): Learn about Cartes Bancaires, a common payment method in France.
eftpos Australia: Learn about eftpos Australia, a common payment method in Australia.
Stablecoin payments: Learn about accepting payments in stablecoins.
Buy now, pay later: Learn about buy now, pay later methods with Stripe.
Afterpay and Clearpay payments: Offer your customers flexible financing while getting paid upfront with Afterpay (also known as Clearpay in the UK).
Affirm payments: Offer your US and Canadian customers flexible financing while getting paid upfront with Affirm.
Klarna payments: Allow customers to make flexible payments while getting paid upfront with Klarna.
Bank redirects: Learn about bank redirects with Stripe.
Bank transfer payments: Learn about bank transfers and managing payments with the customer balance.
Real-time payments: Learn about real-time payments with Stripe.
Vouchers: Learn about voucher payment methods with Stripe.
Wallets: Learn about wallet payments with Stripe.
Enable local payment methods by country: Use South Korean and Nigerian payment methods.
Custom payment methods: Extend your integrations with additional payment methods processed outside of Stripe.
Orchestration: Create rules to route payments across your payment processors.
Checkout
Use a prebuilt Stripe-hosted payment page
Build a Stripe-hosted checkout page
Embed a payment form in your site
How Checkout works: Learn how to use Checkout to collect payments on your website.
Customize Checkout: Customize the appearance and behavior of Checkout.
The Setup Intents API: Learn more about the Setup Intents API for saving payment methods.
Fulfill orders: Learn how to fulfill payments received with the Checkout Sessions API.
Customize redirect behavior: Display a confirmation page with your customer's order information.
Add discounts: Reduce the amount charged to a customer by discounting their subtotal with coupons and promotion codes.
Use your custom domain: Learn how to bring your own custom domain to Stripe Checkout, Payment Links, and customer portal.
Limit customers to one subscription: Direct customers to manage their subscription when they already have one.
Cross-sells: Enable customers to purchase complementary products at checkout by using cross-sells.
Overview: Model your business on Stripe with products and prices.
Subscriptions: Create subscriptions for your customers.
Charge for shipping: Create different shipping rates for your customers.
Collect taxes: Learn how to collect taxes with Stripe Tax.
Manage payment methods: Use dynamic payment methods or manually define the payment methods to allow per checkout session.
Customize text and policies: Customize the text that your customers see, and the policies Checkout displays.
Add custom fields: Add additional fields to a prebuilt payment page with Checkout.
Collect physical addresses: Learn how to collect billing and shipping addresses.
Customize card brands: Customize the card brands that Checkout displays.
Save payment details during payment: Learn how to accept a payment and save your customer's payment details for future purchases.
After the payment: Customize the post-payment checkout process.
Set the billing cycle date: Set a subscription's billing cycle anchor to a fixed date.
Let customers decide what to pay: Accept tips and donations, or sell pay-what-you-want products and services.
Subscription upsells: Enable customers to upgrade their subscription plan at checkout by using upsells.
No-cost orders: Accept orders for no-cost line items or apply 100% off discounts for one-time payments.
Analyze your conversion funnel: Analyze your Stripe Checkout conversion funnel with Google Analytics 4.
Add discounts, upsells, and optional items: Boost sales with discounts and offers.
Manual currency prices: Present local currencies to customers with manual currency prices.
Collect customer phone numbers: Collect a phone number for shipping or invoicing when your customer makes a payment.
Dynamically customize shipping options: Update shipping options based on a customer's shipping address.
One-time payments with Checkout: Learn how to accept one-time card payments with just a few lines of code.
Set up future payments: Learn how to save payment details in a Checkout session and charge your customers later.
Make line item quantities adjustable: Enable your customers to adjust the quantity of items during checkout.
Elements with Checkout Sessions API beta changelog: Keep track of changes to the Elements with Checkout Sessions API beta integration.
Checkout prices migration guide: Learn how to update your integration to use prices with Stripe Checkout.
Checkout Sessions
The Checkout Session object
Create a Checkout Session
Payments
Accept a payment: Securely accept payments online.
The Payment Intents API: Learn how to use the Payment Intents API for Stripe payments.
Multi-currency settlement: Accept, settle, and pay out funds in multiple currencies.
Stripe decline codes: Learn about Stripe decline codes and how to resolve them when a charge fails.
Place a hold on a payment method: Separate payment authorization and capture to create a charge now, but capture funds later.
Save a customer's payment method when they use it for a payment: Learn how to save your customer's payment details for future purchases when they make a payment.
Save a customer's payment method without making a payment: Learn how to save a payment method and charge it later.
Payment status updates: Monitor and verify payment status, so that you can respond to successful and failed payments.
Payment method integration options: Learn about the different ways to integrate payment methods.
Payment Methods API: Learn more about the API that powers a range of global payment methods.
Create an embeddable buy button: Use Payment Links to create an embeddable buy button for your website.
After a payment link payment: Learn what you can do after receiving a payment link payment.
Share a payment link: Share payment links across social media, emails, or your website.
Payment Intents
The PaymentIntent object
Create a PaymentIntent
Payment Methods
The PaymentMethod object
Create a PaymentMethod
Link
Link in different payment integrations: Use Link with dynamic payment methods and other integrations.
Instant Bank Payments: Accept low cost bank payments with instant confirmation.
Link with Checkout: Use Link with Stripe's prebuilt checkout page.
Link in different payment integrations: Use Link with dynamic payment methods and other integrations.
Link in the Payment Element: Link in the Payment Element lets your customers check out faster.
Link in the Card Element: Enable checkout using Link with the Card Element.
Link in the Mobile Payment Element: Add Link to your native iOS, Android, and React Native apps.
Link in the Express Checkout Element: Let customers check out faster with Link and the Express Checkout Element.
Link with Invoicing: Speed up invoice payments by using Link with the Hosted Invoice Page.
Explore the Link Authentication Element: Create a single email input for both email collection and Link authentication.
Architecture and Dashboard
Set up your development environment: Get familiar with the Stripe CLI and our server-side SDKs.
Add funds to your Stripe balance: Cover increased refunds and chargebacks by adding funds to your balance.
Web Dashboard: Learn how to use the web version of the Stripe Dashboard.
Stripe Dashboard mobile app: Learn how to use the mobile app version of the Stripe Dashboard.
Browse sample projects: Explore the library of sample projects using Stripe.
Tour of the API: See how Stripe API objects fit together and learn best practices for combining them.
Go-live checklist: Use this checklist when taking your integration live.
Build and test new features: Build and test new features using the Stripe developer tools.
Perform searches in the Dashboard: Use the Dashboard to search for payments, customers, and more.
Test Apple and Google wallet rendering: Compare your integration against working demo integrations to identify possible rendering issues.
Instructions for Large Language Model Agents: Best Practices for integrating Stripe
Billing
Recurring pricing models: Learn about the pricing models you can use with subscriptions.
Build a pre-built subscription page with Stripe Checkout
Coupons and promotion codes: Add discounts to subscriptions and subscription items using coupons and promotion codes.
Cancel subscriptions: Learn how to cancel existing subscriptions.
Set the subscription billing renewal date: Learn how to set the billing date for subscriptions.
Embeddable pricing table for subscriptions: Display a subscription pricing table on your website and take customers directly to Stripe Checkout.
Change the price of existing subscriptions: Learn how to upgrade and downgrade subscriptions by changing the price.
Create subscriptions: Set up recurring payments by offering subscriptions to your service.
Modify subscriptions: Change existing subscriptions to cancel, pause, apply prorated charges and credits, and more.
Customer Tax IDs: Learn how to store, validate, and render customer tax ID numbers with Stripe Billing.
Set up a pay-as-you-go pricing model: Charge customers based on their usage of your product or service.
Entitlements: Determine when you can grant or revoke product feature access to customers.
Set payment methods per-subscription: Learn how to specify which payment methods are available for a subscription.
Recurring pricing models: Learn about the pricing models you can use with subscriptions.
Customers: Learn how to use the Customer resource with Stripe Billing.
Subscription use cases: Learn about some of the business use cases for subscriptions.
Integrate a SaaS business on Stripe: Learn how to build a Software as a Service (SaaS) business with Billing and other Stripe products.
Record usage for billing: Learn how to record customer usage data.
Design a subscriptions integration: Learn about the configuration options for a subscriptions integration.
Pause payment collection: Learn how to pause payment collection on subscriptions.
Tax rates: Learn how to collect and report taxes with tax rate objects.
Migrate subscriptions to Stripe Billing: Learn about migrating subscriptions from other sources to Stripe.
Set payment methods per-subscription: Learn how to specify which payment methods are available for a subscription.
Set product or subscription quantities: Subscribe a customer to multiple products, or to multiple quantities of a single product, all billed in a single invoice.
Overview: Successfully migrate your customers and their payments data to Stripe.
Revenue recovery: Learn about automated recovery features that reduce and recover failed subscription payments.
Migrate subscriptions to Stripe Billing using toolkit: Learn how to migrate your existing subscriptions to Stripe using the toolkit.
About the Billing APIs: Understand how the Billing API objects work together.
Subscriptions
The Subscription object
Create a subscription
Customers
The Customer object
Customer Balance Transaction
The Customer Balance Transaction object
Elements
Checkout Sessions API
Payment Intents API
Address Element: Use the Address Element to collect complete billing and shipping addresses.
Link Authentication Element: Use the Link Authentication Element to integrate Link.
Payment Sheet: A prebuilt UI that presents payment methods in a sheet.
Payment Element: Embed payment methods directly in your app.
Migrate to Confirmation Tokens: Finalize payments on the server by using a ConfirmationToken instead of a PaymentMethod.
Migrate from the Basic Integration to the Payment Sheet: Upgrade your legacy mobile SDK integration before we remove it from the SDK.
Control billing details collection: Customize the billing details you collect within the Payment Element.
Address Element: Use the Address Element to collect complete billing and shipping addresses for in-app integrations.
Collect physical addresses and phone numbers: Learn how to collect addresses and phone numbers during one-time payment flows.
Collect physical addresses and phone numbers: Learn how to collect customer addresses and phone numbers in your mobile app with the Address Element.
Use Payment Element across multiple processors: Learn how to collect card details with Payment Element and use them with a third-party processor.
Customize appearance: Customize your mobile integration with the Appearance API.
Charge for shipping: Create different shipping rates for your customers.
Connect
Acceptable verification documents by country: Learn which documents Stripe accepts for verification of identity, address, and legal entity.
1099-NEC form state requirements: View the state requirements for 1099-NEC forms.
Understand how charges work in a Connect integration: Learn about the types of charges used in Connect integrations and how funds move between the platform and connected accounts.
Required verification information: Identify current and future information requirements that connected accounts must provide based on their business, location, and requested capabilities.
Connect account types: Learn about older connected account configurations.
US tax reporting for Connect platforms: Learn how to report the annual payments for your US-based connected accounts.
How Connect works: Learn how Connect's features support multiparty integrations.
Payouts to connected accounts: Manage payouts and external accounts for your platform's connected accounts.
1099-K form state requirements: View the state requirements for 1099-K forms.
Making API calls for connected accounts: Learn how to add the right information to your API calls so you can make calls for your connected accounts.
Using Connect with Standard connected accounts: Use Standard connected accounts to get started using Connect right away, and let Stripe handle the majority of the connected account experience.
Choose your onboarding configuration: Learn about the different options for onboarding your connected accounts.
Using Connect with Custom connected accounts: Use Custom connected accounts with Connect to control your connected accounts' entire experience.
Express Dashboard: Learn about the features of the Express Dashboard.
Stripe-hosted onboarding: Onboard connected accounts by redirecting them to a Stripe-hosted onboarding flow.
Payment details: Show details of a given payment and allow users to manage disputes and perform refunds.
Identity verification for connected accounts: Use identity verification to reduce risk on your platform when using Connect.
Using manual payouts: Send manual payouts to your connected accounts.
Connect webhooks: Learn how to use webhooks with Connect to be notified of Stripe activity.
Manage connected accounts with the Dashboard: Learn about using the Stripe Dashboard to find and manage connected accounts.
Get started with tax reporting: Use the Stripe 1099 tax reporting product to create, modify, file, and deliver tax forms for your connected accounts.
Platform pricing tool: Set platform processing fees for your connected accounts from your Stripe Dashboard.
Update and create 1099 tax forms: Update and create 1099 tax forms for connected accounts.
Balance
The Balance object
Issuing
How Issuing works: Learn how to start building a card program with Stripe Issuing.
Issuing merchant categories: Learn about the available categories that businesses are grouped in.
Cardholder authentication using 3D Secure: Learn about 3D Secure, an additional layer of authentication used by businesses to combat fraud.
Physical cards: Issue physical cards at Stripe.
Use digital wallets with Issuing: Learn how to use Issuing to add cards to digital wallets.
Using Issuing Elements: Learn how to display card details in your web application in a PCI-compliant way.
Issuing and Financial Accounts product marketing, design, and compliance guidelines: Learn how to launch and maintain compliant Issuing and Financial Accounts programs.
Issuing Disclosure Component: Learn how to embed an Issuing disclosure component directly onto your website.
Virtual cards with Issuing: Learn about virtual cards created with Issuing.
Choose which type of card to issue: Decide on physical or virtual cards for your cardholders.
Use Stripe Issuing in different countries: Learn how different integration options vary by country.
Issuing and Financial Accounts for platforms sample app: Learn how to onboard customers, issue cards, and make outbound payments.
B2B payments integration guide: Build a B2B payments integration with Issuing.
Test your Issuing integration: Learn how to test your integration and simulate purchases.
Issuing and Financial Accounts for platforms sample app: Use the Stripe Next.js sample app to start your own Issuing and Financial Accounts for platforms integration.
Manage fraud with Stripe Issuing controls and tools: Understand how transaction fraud can impact your Issuing program and the steps you can take to combat it.
Add funds to your card program: Learn about your options to fund card spend.
Stripe Issuing marketing guidelines: Learn about marketing guidelines for Issuing programs in the United Kingdom and Europe.
Order a custom bundle: Order your custom physical bundle.
Use cards at automated teller machines (ATMs): Learn how you can use your Stripe Issuing cards at ATMs.
Create a design: Create and name your bundle design.
Onboarding overview: Take your integration live.
Replacement cards: Learn how to replace cards that are expired, damaged, lost, or stolen.
Choose your physical bundle: Set up a standard or custom physical bundle.
Update the Issuing terms of service acceptance: Learn how to present accurate business information for your connected accounts and accept the Issuing terms of service.
Customize card bundle: Make your card bundle selections.
Issuing watchlist: Learn about the Issuing watchlist process and best practices.
Capital
How Stripe Capital works: Learn how Stripe Capital provides financing for eligible businesses.
How Stripe Capital works: Learn how Stripe Capital provides financing for eligible businesses.
Set up Capital: Determine which integration option to use when you set up Stripe Capital.
How Stripe Capital for platforms works: Learn the basics about Stripe Capital for platforms.
Managing customer support: Support your Capital customers using Stripe-approved messaging.
Capital financing component: Allow a connected account to view and manage their active Capital financing.
Build a custom Capital program: Integrate with our API to build a custom Capital program.
Capital application component: Show an end-to-end application flow for Capital financing.
Regulatory compliance guidelines: Learn about the requirements and guidelines for regulatory compliance.
Marketing your Capital program: Build marketing assets for Capital.
Capital promotion component: Show promotional content about a connected account's Capital financing offer and launch a Capital application.
Capital metrics: Access financing offer data in the Stripe Dashboard.
Refills: Learn how to enable refills for your Capital program.
Replacements: Learn how to handle financing offer replacements.
Crypto
Stablecoin payments: Learn about accepting payments in stablecoins.
Accept stablecoin payments: Start accepting stablecoins by enabling the Crypto payment method.
Use the Stripe-hosted onramp: Generate a redirect URL and mint a session for the standalone onramp.
Set up an Embedded onramp integration: Use this guide to fully customize the embeddable onramp.
Embedded Components onramp: Learn about the Embedded Components onramp.
Set up an Embedded onramp integration: Use this guide to fully customize the embeddable onramp.
Set up an Embedded onramp integration: Use this guide to fully customize the embeddable onramp.
Set up an Embedded onramp integration: Use this guide to fully customize the embeddable onramp.
Climate
Climate Commitments: Direct a fraction of your revenue to help advance carbon removal.
Climate Orders overview: Pre-order carbon removal tons from Frontier's offtake portfolio
Order carbon removal: Pre-order carbon removal tons from Frontier's offtake portfolio.
Carbon removal inventory: Learn about available carbon removal inventory.
- URL: https://docs.
…(truncated)