Stripe for AI agents
Agents read Stripe at once. Changes and sends are held for a person's approval by default.
About Stripe
Stripe offers online payment infrastructure, fraud prevention, and APIs enabling businesses to accept and manage payments globally
What an agent can do in Stripe
Every Stripe action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Stripe without asking first. 201 actions.
- Get Charge Refund DetailsTool to retrieve the details of an existing refund within a specific charge. Use when you need to get refund information using both the charge ID and refund ID.
- Get Checkout Session Line ItemsTool to retrieve line items for a Checkout Session. Use when you need to view the items, pricing, quantities, and totals for a specific checkout session.
- Retrieve customer bank accountRetrieves details about a specific bank account stored on a Stripe customer. Use when you need to view bank account information for a customer.
- Get customer cash balanceTool to retrieve a customer's cash balance. Use when you need to check the current cash balance for a specific Stripe customer, including available funds by currency.
- List customer payment methodsRetrieves a list of payment methods for a given customer, supporting type filtering and pagination.
- Get customer subscription discountTool to retrieve the discount currently applied to a customer's subscription. Use when you need to check if a subscription has an active discount and get details about the coupon or promotion code.
- Retrieve InvoiceTool to retrieve a specific invoice by ID. Use when you need to get detailed information about an existing invoice.
- Get Invoice Line ItemsTool to retrieve a paginated list of line items for a specific invoice. Use when you need to see the individual charges, products, or services included in an invoice.
- Retrieve payment linkTool to retrieve details of an existing Stripe payment link by ID. Use when you need to get information about a specific payment link.
- Retrieve payment method configurationTool to retrieve a specific payment method configuration by its unique identifier. Use when you need to inspect the settings and availability of payment methods for a given configuration.
- Retrieve a priceRetrieves detailed information for a specific Stripe price using its unique ID. Use when you need to fetch price details.
- Retrieve a productRetrieves detailed information for an existing Stripe product using its unique product ID. Use when you need to fetch details about a specific product.
Show all 201
- Retrieve product featureRetrieves a specific product feature by its ID. Use when you need to get details about a particular feature attached to a product.
- Retrieve a refundTool to retrieve details of a specific Stripe refund by ID. Use when you need to get information about an existing refund.
- Retrieve subscription scheduleRetrieve a subscription schedule using its unique identifier. Use when you need to view details of an existing schedule including phases, settings, and status.
- Search Stripe customersTool to search for Stripe customers using Stripe's Search Query Language. Use when you need to find customers by email, metadata, creation date, or other customer attributes.
- List payment methodsTool to retrieve a list of PaymentMethods with filtering and pagination support. Use when you need to list payment methods, optionally filtering by customer, type, or redisplay settings.
- List Balance TransactionsLists all balance transactions for the connected Stripe account. Use this action when you need to retrieve the transaction history of funds moving through your Stripe account. Balance transactions are
- List Charge RefundsLists all refunds for a specific charge in Stripe. Use this action when you need to retrieve all refunds associated with a particular charge ID. This is useful for tracking refund history for a specif
- List Checkout SessionsTool to retrieve a list of Stripe Checkout Sessions with pagination support. Use when you need to list checkout sessions, optionally filtering by customer, status, payment intent, or other criteria.
- List customer subscriptionsTool to list all active subscriptions for a customer in Stripe. Use when you need to retrieve all subscriptions associated with a specific customer ID. Supports pagination via starting_after and endin
- List Invoice ItemsRetrieves a paginated list of Stripe invoice items. Use to filter by customer, invoice, creation date, or attachment status with cursor-based pagination.
- List Invoice Rendering TemplatesTool to list all invoice rendering templates ordered by creation date. Use when you need to retrieve available invoice rendering templates.
- List payment linksRetrieves a list of payment links from Stripe, sorted by creation date in descending order by default.
- List RefundsLists Stripe refunds, sorted by creation date descending (newest first), with optional filtering by charge or payment_intent and pagination support.
- List tax ratesRetrieves a list of tax rates, which are returned sorted by creation date in descending order.
- Retrieve Charge DetailsRetrieves full details for an existing Stripe charge using its unique ID.
- Retrieve customerRetrieves detailed information for an existing Stripe customer using their unique customer ID.
- Retrieve payment intentRetrieves a PaymentIntent by its ID; `client_secret` is required if a publishable API key is used.
- Search Stripe customersRetrieves a list of Stripe customers matching a search query that adheres to Stripe's Search Query Language.
- Search payment intentsSearches for PaymentIntents using Stripe's Search Query Language. Use when you need to find payments by status, amount, customer, or other criteria.
- Search Stripe pricesSearch for prices using Stripe's Search Query Language. Use when you need to find prices by status, currency, product, or other criteria with flexible query syntax.
- Search Stripe productsTool to search for products using Stripe's Search Query Language. Use when you need to find products based on specific criteria like active status, name, or metadata.
- Search subscriptionsSearches for subscriptions using Stripe's Search Query Language. Use when you need to find subscriptions by status, metadata, created timestamp, or canceled_at timestamp.
- Who Am IReturn the connected Stripe account (account id, dashboard name). Identity is account-level.
- Find a secret by name and scopeTool to find a secret by name and scope in the Stripe Apps secret store. Use when you need to retrieve a specific secret's details based on its name and scope.
- Find tax associationTool to find a tax association by PaymentIntent ID. Use when you need to retrieve tax calculation and transaction details linked to a specific payment.
- Retrieve AccountRetrieves detailed information for the authenticated Stripe account. Use when you need to access account capabilities, requirements, settings, or business profile.
- List Account CapabilitiesRetrieves a list of all capabilities for a connected Stripe account. Use when you need to check all available capabilities, their statuses, and requirements for an account.
- Retrieve Account CapabilityRetrieves information about a specific capability for a Stripe account. Use when you need to check the status, requirements, or configuration of a capability such as card payments, transfers, or ACH p
- Retrieve Person from AccountRetrieves an existing person associated with a Stripe account. Use when you need to check the details, verification status, or requirements of a specific person on an account.
- List all persons for an accountRetrieves a list of people associated with the account's legal entity. Use when you need to list all persons for an account, with optional filtering by relationship type.
- Retrieve AccountRetrieves the details of a Stripe account. Use when you need to check account properties like current requirements, live charge capability, payout eligibility, business details, or verification status
- Retrieve Account TokenTool to retrieve a v2 Account Token by its ID. Use when you need to fetch details about a specific account token, including its creation time, expiration, and usage status. Account tokens are single-u
- Retrieve active entitlementTool to retrieve an active entitlement describing customer access to a feature. Use when you need to check specific entitlement details for a customer.
- Retrieve Apple Pay DomainRetrieves details about a previously registered Apple Pay domain. Use when you need to fetch information about a specific Apple Pay domain that was registered with Stripe.
- Get balance settings overviewTool to retrieve balance settings for a Stripe account. Use when you need to fetch configuration options for customizing account balances and payout settings for a connected account or the authenticat
- Retrieve Balance TransactionRetrieves the balance transaction with the given ID. Use when you need detailed information about a specific balance transaction including amounts, fees, availability dates, and transaction sources.
- Retrieve Billing AlertRetrieves a billing alert by its unique identifier. Use when you need to fetch details of a specific billing alert that notifies when a certain usage threshold on a meter is crossed.
- Get Billing Credit Balance SummaryRetrieves the credit balance summary for a customer in Stripe Billing. This action returns the available and ledger balances for billing credits granted to a customer. You can filter by a specific cre
- Retrieve credit balance transactionRetrieves a credit balance transaction by its unique identifier. Use when you need to get details about a specific credit or debit transaction against a credit grant.
- List billing credit grantsTool to retrieve a paginated list of billing credit grants. Use when you need to view credit allocations for customers, track promotional credits, or manage billing credits.
- Retrieve billing credit grantRetrieves a billing credit grant by its unique identifier. Use when you need to get details about a specific credit grant allocation for a customer.
- List billing metersTool to retrieve a list of billing meters from Stripe. Use when you need to list meters with optional filtering by status and pagination support.
- Retrieve Billing MeterRetrieves a billing meter by its unique identifier. Use when you need to fetch configuration details and settings for a specific billing meter.
- List portal configurationsTool to list billing portal configurations. Use when you need to retrieve portal configurations that describe the functionality and settings of the customer portal.
- Get billing portal configurationTool to retrieve a billing portal configuration from Stripe. Use when you need to fetch details about a specific portal configuration including branding, features, and settings.
- Retrieve Charge DisputeTool to retrieve a dispute for a specified charge. Use when you need to get dispute details associated with a specific charge ID.
- Retrieve climate productTool to retrieve details of a specific Stripe Climate product. Use when you need to get information about a particular carbon removal product including pricing and supplier details.
- Retrieve climate supplier detailsRetrieves detailed information about a specific Stripe Climate carbon removal supplier. Returns supplier details including name, carbon removal pathway (biomass, direct air capture, or enhanced weathe
- Retrieve Confirmation TokenTool to retrieve an existing ConfirmationToken object by its ID. Use when you need to access payment method details and customer information that were securely passed during the payment confirmation f
- Retrieve Country SpecRetrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies. Use when you need country-specific payment capabili
- Retrieve Coupon DetailsRetrieves full details for an existing Stripe coupon using its unique ID. Use when you need to check coupon validity, discount details, or redemption limits.
- Get Credit Note LinesRetrieves the paginated list of line items for a specific credit note. Use when you need complete details of all line items associated with a credit note.
- Retrieve a credit noteRetrieves a credit note by its unique identifier. Use when you need to get detailed information about a specific credit note.
- Preview Credit NoteTool to preview a credit note without creating it in Stripe. Use when you need to see what a credit note will contain before issuing it.
- Get Credit Note Preview LinesTool to retrieve a credit note preview's line items from Stripe. Use when you need to see what line items would be included in a credit note before creating it.
- Retrieve customer cash balance transactionTool to retrieve a specific cash balance transaction that updated a customer's cash balance. Use when you need to get details about a particular cash balance transaction for a customer.
- List customer balance transactionsTool to list customer balance transactions that updated a customer's balance. Use when you need to retrieve the history of balance changes for a specific customer.
- Retrieve Customer Balance TransactionRetrieves a specific customer balance transaction that updated the customer's balances. Use this when you need to fetch details about a particular balance transaction for a customer.
- List customer bank accountsTool to fetch all bank accounts linked to a customer. Use when you need to retrieve payment source information for a specific customer.
- List all cardsTool to list all cards for a customer. Use when you need to retrieve payment card information for a specific customer.
- Retrieve customer cardRetrieves details about a specific card for a customer. Use when you need to view card information stored on a customer account.
- List cash balance transactionsTool to retrieve a list of cash balance transactions for a customer. Use when you need to view the history of cash balance changes for a specific Stripe customer, including funds added and payments ap
- Get customer discountTool to retrieve the discount currently active on a customer. Use when you need to check a customer's active discount details.
- Retrieve customer's payment methodTool to retrieve a specific PaymentMethod object for a given Customer. Use when you need to get detailed information about a particular payment method associated with a customer.
- List customer sourcesTool to list sources for a specified customer. Use when you need to retrieve payment sources (cards) stored on a customer account.
- Retrieve customer subscriptionTool to retrieve a specific subscription for a customer. Use when you need to get detailed information about a customer's subscription using both customer ID and subscription ID.
- List customer tax IDsTool to retrieve all tax IDs for a specific Stripe customer. Use when you need to list tax identification numbers (VAT, GST, etc.) associated with a customer account.
- Retrieve a customer tax IDTool to retrieve a specific tax ID for a customer. Use when you need to fetch details about a customer's tax identification number.
- List active entitlementsTool to retrieve active entitlements for a customer. Use when you need to check which features a customer currently has access to.
- Retrieve entitlements featureTool to retrieve a feature by ID from Stripe. Use when you need to get details about a specific entitlements feature.
- List eventsRetrieves a list of Stripe events from the past 30 days with filtering and pagination. Use to track API activity and monitor webhook deliveries.
- Retrieve eventRetrieves event details for events created within the last 30 days. Use when you need to fetch webhook event information or verify event data.
- Retrieve file linkRetrieves the details of an existing file link. Use when you need to access file link information or verify if a link is still valid.
- Retrieve FileTool to retrieve details of an existing file object by its unique identifier. Use when you need to get information about a previously uploaded file.
- Retrieve Financial Connections SessionRetrieves the details of a Financial Connections Session. Use when you need to check the status or details of a session.
- Retrieve FX QuoteRetrieve a specific FX (foreign exchange) Quote by its ID. FX Quotes provide exchange rates between currencies that can be locked for a period (5 minutes to 24 hours) to protect against rate fluctuati
- Retrieve Invoice ItemTool to retrieve the details of an invoice item using its unique identifier. Use when you need to fetch information about a specific invoice item.
- Retrieve an invoice paymentTool to retrieve details of a specific Stripe invoice payment by ID. Use when you need to get information about an existing invoice payment.
- Retrieve Linked AccountRetrieves the details of a Linked Account object by its unique identifier. A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degr
- Retrieve mandateTool to retrieve a Stripe mandate by ID. Use when you need to get authorization details for recurring or single-use payments.
- Get monthly recurring revenueReturn Stripe-defined MRR from active and past-due subscriptions as a historical time series. Requires Stripe Analytics API preview access; restricted API keys also need Data > Metrics > Read permissi
- Retrieve Payment Attempt RecordTool to retrieve a specific Payment Attempt Record by ID. Use when you need to get detailed information about a particular payment attempt.
- Get payment intent amount details line itemsTool to retrieve paginated line items for a PaymentIntent. Use when you need to get detailed product and service information including quantities, prices, discounts, and taxes for a specific payment i
- Get payment link line itemsTool to retrieve paginated line items for a payment link. Use when you need to get detailed product and service information including quantities, prices, discounts, and taxes for a specific payment li
- Retrieve payment methodRetrieves the details of a PaymentMethod object by its unique identifier. Returns information including the payment method type (card, us_bank_account, sepa_debit, etc.), billing details, and type-spe
- Retrieve Payment Method DomainRetrieves details of an existing payment method domain. Use when you need to fetch information about a specific payment method domain registered with Stripe.
- Retrieve Payment RecordTool to retrieve a Payment Record from Stripe. Use when you need to access details about payments that occur on- or off-Stripe, including payment attempts and status information.
- Retrieve a payoutTool to retrieve details of an existing Stripe payout. Use when you need to get information about a specific payout by its ID.
- Retrieve planTool to retrieve a specific Stripe plan by its unique identifier. Use when you need to view plan details including pricing, billing frequency, and configuration.
- List Stripe promotion codesRetrieves a list of promotion codes from a Stripe account with optional filters for active status, code value, coupon association, and customer restrictions. Supports cursor-based pagination.
- Get quote detailsTool to retrieve a quote by ID. Use when you need to get detailed information about a specific Stripe quote, including line items, pricing, and status.
- Get Quote Computed Upfront Line ItemsTool to retrieve computed upfront line items for a quote. Use when you need the full paginated list of upfront line items with detailed pricing information including amounts, taxes, and discounts.
- Get Quote Line ItemsTool to retrieve a paginated list of line items for a quote. Use when you need to get details about the items included in a specific Stripe quote.
- Get Radar Value ListRetrieves a specific Stripe Radar value list by its identifier. Use when you need to fetch detailed information about a value list used in Radar rules.
- List Radar value list itemsTool to list all value list items from a Stripe Radar value list. Use when you need to retrieve items from a specific value list for fraud detection rules. Returns items sorted by creation date in des
- Retrieve a Report RunRetrieves details of an existing Report Run object. Use when you need to check the status or retrieve results of a report run.
- Retrieve a report typeTool to retrieve details of a specific Stripe report type by ID. Use when you need to get information about a specific reporting report type.
- List setup attemptsTool to list SetupAttempts associated with a SetupIntent. Use when you need to retrieve all setup attempts for a specific SetupIntent to understand the payment method setup process and any errors that
- Retrieve setup intentRetrieves details of a SetupIntent by its ID; `client_secret` is required if a publishable API key is used.
- Retrieve Shipping RateTool to retrieve details of a specific Stripe shipping rate by its unique ID. Use when you need to fetch information about a particular shipping rate.
- Retrieve subscriptionRetrieves detailed information for an existing Stripe subscription using its unique ID.
- Retrieve subscription itemRetrieves detailed information for a specific subscription item using its unique ID. Use when you need to fetch subscription item details, pricing, or billing information.
- Retrieve Tax CalculationRetrieves a Tax Calculation object by its unique ID. Use when you need to access tax calculation details.
- Get Tax Calculation Line ItemsRetrieves line items of a tax calculation as a paginated collection. Use this to see detailed tax information for each item in the calculation, including amounts, tax breakdowns, and tax rates.
- Retrieve tax codeRetrieves the details of an existing tax code. Use when you need to get information about a specific tax code by its ID.
- Retrieve tax IDRetrieves an account or customer tax ID object. Use when you need to get details about a specific tax identification number stored in Stripe.
- Retrieve a tax rateTool to retrieve the details of an existing tax rate. Use when you need to fetch information about a specific tax rate by its ID.
- Retrieve tax registrationTool to retrieve a specific tax registration configured for your Stripe account. Use when you need to get details about where and how taxes are collected across different jurisdictions.
- Get Tax SettingsRetrieves Tax Settings for a merchant. Use when you need to fetch the tax configuration for a Stripe account.
- Retrieve Tax TransactionRetrieves a Tax Transaction object by ID. Use when you need to fetch details about a specific tax transaction.
- Get tax transaction line itemsRetrieves the line items of a committed standalone tax transaction. Use when you need to view detailed line-by-line breakdown of a tax transaction.
- Retrieve terminal configurationTool to retrieve a specific Terminal Configuration object from Stripe. Use when you need to view the detailed settings for a specific terminal configuration by its ID.
- Retrieve Terminal LocationTool to retrieve a Terminal Location object by ID. Use when you need to get details about a specific terminal location for managing card readers.
- Retrieve Terminal ReaderTool to retrieve a Terminal Reader object by ID. Use when you need to get details about a specific reader device for accepting payment details in Stripe Terminal.
- Retrieve test clockTool to retrieve a test clock by ID. Use when testing billing integrations by simulating time advancement in sandbox environments.
- Retrieve TokenRetrieves the token with the given ID. Use when you need to verify token details or check if a token has been used.
- Retrieve transfer reversalRetrieves a transfer reversal by its ID and the associated transfer ID. Use when you need to check the status, amount, or details of a specific reversal for a Stripe transfer.
- Retrieve Upcoming Invoice Line ItemsTool to retrieve a paginated list of line items for an upcoming invoice preview. Use when you need to see detailed line items before an invoice is finalized.
- Retrieve Dispute DetailsRetrieves detailed information for an existing Stripe dispute by ID. Use when you need to get complete dispute details including evidence, status, and payment information.
- List Invoice PaymentsTool to list invoice payments in Stripe with pagination and filtering options. Use when you need to retrieve payment records associated with invoices.
- List payment method configurationsTool to list all payment method configurations in a Stripe account. Use when you need to retrieve available payment method settings with optional pagination and filtering.
- List payment method domainsTool to retrieve list of payment method domains registered with Stripe account. Use when you need to list all payment method domain objects with optional filtering by domain name and enabled status.
- List Radar Early Fraud WarningsReturns a list of early fraud warnings. An early fraud warning indicates that the card issuer has notified Stripe that a charge may be fraudulent. Use when you need to review potentially fraudulent ch
- Get Radar value lists overviewTool to retrieve an overview of Radar value lists. Use when you need to get a list of value lists used in Stripe Radar for fraud prevention.
- Get reporting report types overviewTool to list all available Stripe report types. Use when you need to discover what reporting types are available for generating reports.
- Get Shipping Rates OverviewTool to retrieve an overview of shipping rates from Stripe. Use when you need a quick summary of recent shipping rates with default limit of 3.
- List subscription schedulesRetrieves a list of subscription schedules with optional filtering and pagination capabilities. Use to view scheduled subscription changes for customers.
- Get tax codesTool to retrieve all tax codes available to add to Products for specific tax calculations. Use when you need to list available Stripe tax codes for product classification.
- List tax IDsTool to retrieve a list of tax IDs with pagination support. Use when you need to list tax IDs for accounts or customers in Stripe.
- Get tax ratesTool to retrieve all tax rates with pagination support. Use when you need to list Stripe tax rates with optional filters for active status, inclusive/exclusive type, and creation date.
- Retrieve V2 Core EventRetrieves detailed information about a specific event from Stripe V2 Core Events API. Use when you need to fetch event details including metadata and related objects.
- List subscription item period summariesTool to list all subscription item period summaries. Use when you need to retrieve usage information for a specific subscription item over billing periods. Returns summaries sorted in reverse-chronolo
- List Apple Pay domainsRetrieves a list of Apple Pay domains registered with Stripe. Use when you need to fetch all registered Apple Pay domains with pagination support.
- List Application FeesReturns a list of application fees you've previously collected, sorted by creation date descending (newest first). Use when you need to retrieve application fees with optional filtering by charge and
- List apps secretsTool to list all secrets stored on the given scope. Use when you need to retrieve secrets from the Secret Store API for Stripe Apps.
- List billing alertsTool to retrieve a paginated list of billing alerts. Use when you need to view billing alerts that notify when usage thresholds on meters are crossed.
- List credit balance transactionsTool to retrieve a paginated list of credit balance transactions with optional filtering. Use when you need to view credit and debit transactions for customer credit grants or track billing credit act
- List ChargesRetrieves a list of Stripe charges with filtering and pagination; use valid cursor IDs from previous responses for pagination, and note that charges are typically returned in reverse chronological ord
- List Climate OrdersTool to list all Climate order objects. Use when you need to retrieve carbon removal orders sorted by creation date with most recent first.
- List climate productsTool to retrieve a list of available Stripe Climate products. Use when you need to see carbon removal offerings with pricing and supplier information.
- List climate suppliersTool to retrieve a list of available Stripe Climate supplier objects for carbon removal. Use when you need to see carbon removal providers including biomass carbon removal, direct air capture, and enh
- List country specsRetrieves a list of country specifications available in the Stripe API. Use when you need details about supported currencies, payment methods, and verification requirements for specific countries.
- List Stripe couponsRetrieves a list of discount coupons from a Stripe account, supporting pagination via `limit`, `starting_after`, and `ending_before`.
- List Credit NotesLists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support.
- List customersRetrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination.
- List DisputesTool to list all disputes from a Stripe account. Use when you need to retrieve disputes with optional filtering by charge or payment intent.
- List entitlements featuresRetrieves a paginated list of entitlements features from Stripe. Use when you need to list monetizable abilities or functionalities in your system that can be assigned to products.
- List file linksTool to retrieve a list of Stripe file links. Use when you need to list file links with optional filters for creation date, expiration status, and associated file.
- List filesTool to retrieve a list of files that your account has access to. Use when you need to list files uploaded to Stripe, with optional filtering by purpose or creation date.
- List Financial Connections AccountsTool to list Financial Connections Account objects representing external financial accounts. Use when you need to retrieve accounts linked through Financial Connections.
- List forwarding requestsLists ForwardingRequest objects from Stripe's Vault and Forward API. ForwardingRequests are records of requests Stripe made to third-party endpoints on your behalf, with payment card details securely
- List FX quotesRetrieves a list of FX quotes that have been issued, with the most recent appearing first. Use for locking exchange rates for payments or transfers.
- List Invoice PaymentsTool to list all payments for invoices in Stripe. Use when you need to retrieve payment information associated with invoices, including pagination and filtering by invoice ID, status, or creation date
- List InvoicesRetrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses.
- List meter event summariesTool to retrieve billing meter event summaries for a customer within a time range. Use when you need aggregated meter event data for billing analysis.
- List Payment Attempt RecordsTool to list payment attempt records for a specified payment record. Use when you need to retrieve all attempts made to process a specific payment.
- List payment intentsTool to list PaymentIntents from Stripe. Use when you need to retrieve a list of payment intents with optional filtering by customer, creation date, or pagination parameters.
- List PayoutsLists Stripe payouts sent to external accounts or received from Stripe, sorted by creation date descending (newest first), with optional filtering by arrival date, creation date, destination, and stat
- List plansTool to list all billing plans from Stripe account. Use when you need to retrieve plans for subscription management or display available pricing options.
- List pricesTool to list Stripe prices. Use when you need to retrieve and filter price objects before processing write operations.
- List productsRetrieves a list of Stripe products, with optional filtering and pagination; `starting_after`/`ending_before` cursors must be valid product IDs from a previous response.
- List product featuresRetrieves a list of features attached to a product. Returns a paginated list of product_feature objects representing attachments between features and products.
- List Stripe promotion codesTool to retrieve a list of promotion codes from Stripe. Use when you need to view, filter, or paginate through promotion codes with optional filters for active status, code, coupon, customer, or creat
- List QuotesRetrieves a list of Stripe quotes with pagination support. Use to fetch quotes by customer, status, or creation date.
- Get Radar Early Fraud WarningsTool to list all early fraud warnings from Stripe Radar. Use when you need to retrieve fraud warnings for charges, optionally filtered by charge ID or payment intent ID.
- List Radar ReviewsReturns a list of Radar Review objects that have open set to true, sorted in descending order by creation date. Use when you need to retrieve reviews that require action with optional filtering and pa
- List Report RunsLists Stripe Report Runs, sorted by creation date descending (newest first). Use when you need to retrieve reporting data or check the status of report generation tasks.
- List open reviewsRetrieves a list of open Stripe reviews with pagination support. Use when you need to access reviews that require action, sorted by creation date with most recent first.
- List SetupAttemptsTool to list SetupAttempts associated with a SetupIntent. Use when you need to retrieve attempts to confirm a SetupIntent and attach a payment method to a customer.
- List setup intentsTool to list SetupIntents from Stripe. Use when you need to retrieve a list of setup intents with optional filtering by customer, payment method, or pagination parameters.
- List Sigma scheduled query runsTool to list all Sigma scheduled query runs. Use when you need to retrieve query runs from Stripe Sigma to access query results or check run status.
- List subscription itemsList all subscription items for a given subscription. Subscription items represent the individual products/prices that make up a subscription. Use this to retrieve items associated with a specific Str
- List subscriptionsRetrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination.
- List tax codesRetrieves a paginated list of globally available, predefined Stripe tax codes used for classifying products and services in Stripe Tax.
- List tax registrationsRetrieves a paginated list of tax registrations. Use when you need to view where a business is registered to collect tax on payments within various regions.
- List terminal configurationsTool to retrieve a list of Terminal Configuration objects from Stripe. Use when you need to view all terminal configurations with optional filtering and pagination.
- List terminal locationsRetrieves a list of Stripe terminal locations with pagination support. Use when you need to view all terminal locations for managing physical card readers.
- List terminal readersTool to list all Stripe Terminal Readers with optional filtering. Use when you need to retrieve readers by device type, location, serial number, or status.
- List test clocksRetrieves a paginated list of test clocks. Use when you need to view all test clocks for testing time-dependent functionality.
- List Top-upsTool to retrieve a list of existing top-ups from Stripe. Use when you need to view top-ups with optional filtering by amount, status, or creation date, and pagination support.
- List transfersList all transfers sent to connected accounts. Transfers are returned in reverse chronological order. Use when you need to retrieve transfer history or monitor funds sent to connected accounts.
- List V2 Core Event DestinationsRetrieves a list of event destinations from Stripe V2 Core Events API. Use when you need to list all event destinations including webhooks and EventBridge integrations.
- List v2 core eventsTool to list v2 core events from Stripe. Use when you need to retrieve a list of events with thin payloads containing references to changed objects. These events are unversioned and require fetching t
- Retrieve BalanceRetrieves the complete current balance details for the connected Stripe account.
- Retrieve Checkout SessionTool to retrieve a Checkout Session object from Stripe. Use when you need to get the current state of a checkout session, including payment status, customer details, and line items.
- Retrieve Promotion CodeTool to retrieve a Stripe promotion code by its ID. Use when you need to get details about a specific promotion code including its associated coupon, usage restrictions, and redemption statistics.
- Retrieve Upcoming InvoiceTool to preview the upcoming invoice for a customer, showing all pending charges including subscription renewals and invoice items. Use when you need to preview invoice amounts before they are finaliz
- Search Stripe chargesSearch charges using Stripe's Search Query Language. Use when you need to find historical charges by status, amount, customer, metadata, or other criteria.
- Search invoicesSearches for invoices using Stripe's Search Query Language. Use when you need to find invoices by status, total amount, customer, currency, or other criteria. Data is typically searchable within one m
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 219 actions.
- Add lines to invoiceTool to add multiple line items to a draft Stripe invoice. Use when you need to add additional charges, services, or credits to an existing invoice that is still in draft status.
- Attach payment to invoiceAttaches a PaymentIntent or Out of Band Payment to an invoice's payments list. When the PaymentIntent status changes to succeeded, the payment is credited to the invoice. Use when you need to associat
- Attach payment method to customerAttaches a PaymentMethod to a Customer. Use when you need to save a payment method for future use with a specific customer. The PaymentMethod must be in a detached state before attaching.
- Cancel payment intentCancels a PaymentIntent when in cancelable state. Use when a PaymentIntent is no longer needed to prevent further charges. For PaymentIntents with status='requires_capture', the remaining amount_captu
- Cancel subscriptionCancels a customer's active Stripe subscription at the end of the current billing period, with options to invoice immediately for metered usage and prorate charges for unused time.
- Capture payment intentCaptures the funds of an existing uncaptured PaymentIntent. Use when the PaymentIntent status is 'requires_capture'.
- Confirm payment intentTool to confirm customer intent to pay with current or provided payment method. Use when ready to finalize a PaymentIntent and initiate the payment attempt. A return_url is required if confirmation ne
- Create billing credit grantTool to create a credit grant that allocates billing credits to a customer for use against metered pricing. Use when you need to provide promotional or paid credits to customers.
- Create billing meterTool to create a billing meter in Stripe for tracking usage events. Use when you need to set up a new meter to track API calls, storage usage, or other measurable customer actions that form the basis
- Create Billing Meter Event V2Creates a billing meter event using Stripe API v2 for usage-based billing. Use when recording customer usage that will be metered and billed according to configured billing meters.
- Create Charge RefundTool to create a refund for a charge in Stripe. Use when you need to refund a previously created charge fully or partially.
- Create Checkout SessionTool to create a Stripe Checkout Session. Use when you need a secure, hosted URL to collect payments or subscriptions via Stripe Checkout.
Show all 219
- Create CustomerCreates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications.
- Create Customer Balance TransactionTool to create an immutable transaction that updates the customer's credit balance. Use when you need to manually adjust a customer's balance, such as issuing credits or debits.
- Create customer cardCreates a card or bank account payment source for a Stripe customer. Use when you need to add a new payment method to a customer for future use. Supports both card and bank account creation. Note: To
- Create card or payment sourceAttaches a payment source to a customer for later reuse. Use when you need to save a card, bank account, or other payment source for future charges.
- Create Customer Tax IDCreates a new tax ID for a customer, used for tax compliance and invoicing across 100+ supported country-specific tax ID formats. Use when you need to add tax identification to a customer account.
- Create an invoiceCreates a new draft Stripe invoice for a customer; use to revise an existing invoice, bill for a specific subscription (which must belong to the customer), or apply detailed customizations. Note: Stri
- Create Payment LinkTool to create a Stripe Payment Link. Use when you need to generate a hosted checkout page URL that can be shared with customers to collect payments without building custom checkout infrastructure. Su
- Create payment methodCreates a PaymentMethod object representing a customer's payment instrument (card, bank account, etc.). PaymentMethods can be: - Attached to a Customer for future use - Used directly with PaymentInten
- Create a priceCreates a new Stripe Price for a product, defining its charges (one-time or recurring) and billing scheme; requires either an existing `product` ID or `product_data`.
- Create productCreates a new product in Stripe, encoding the request as `application/x-www-form-urlencoded` by flattening nested structures.
- Create RefundCreates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID.
- Create Reversal Tax TransactionCreates a reversal of an existing tax transaction. Use when you need to fully or partially reverse tax calculations, either for full refunds or specific line items.
- Create subscriptionCreates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options.
- Create subscription itemTool to add a new item to an existing subscription without changing existing items. Use when adding a product or service to a customer's subscription.
- Deactivate Billing MeterDeactivates a billing meter. Use when you need to stop a meter from accepting new events and prevent it from being attached to prices.
- Delete couponTool to delete a coupon from Stripe. Use when you need to remove a coupon code, preventing new redemptions while preserving existing customer discounts.
- Delete customer bank accountDeletes a bank account payment source from a customer. This action is irreversible — the bank account cannot be recovered once deleted. Use when you need to remove a bank account from a customer's pay
- Delete customer discountRemoves the currently applied discount on a customer. Use when you need to remove a coupon or promotion code discount from a customer's account.
- Delete customerPermanently deletes a customer and cancels active subscriptions. Use when you need to remove a customer record from your Stripe account. This operation is irreversible and automatically terminates any
- Delete customer subscription discountRemoves currently applied discount from a customer's subscription. Use when you need to remove a discount code or promotion from a specific subscription belonging to a customer.
- Delete customer tax IDDeletes a customer's tax ID object. Use when you need to remove a specific tax identification from a customer's account.
- Delete draft invoicePermanently deletes a draft invoice. This action cannot be undone. Use when you need to remove a draft invoice. Finalized or subscription invoices must be voided instead.
- Delete invoice itemTool to delete an invoice item from Stripe. Use when removing invoice items that are not attached to invoices or attached to draft invoices.
- Delete planTool to delete a plan from Stripe. Use when you need to permanently remove a pricing plan. Prevents new subscribers from being added to the plan, but existing subscribers remain unaffected.
- Delete productDelete a product. Deleting a product is only possible if it has no prices associated with it. Products with type=good cannot be deleted if they have SKUs.
- Delete subscription itemDeletes a subscription item without canceling the subscription. Use when you need to remove a specific item from a customer's subscription while keeping the subscription active.
- Delete Terminal LocationTool to permanently delete a Terminal Location object from your Stripe account. Use when you need to remove a physical location where Terminal readers are no longer deployed. This operation is permane
- Cancel subscriptionTool to cancel a Stripe subscription immediately. Use when you need to permanently cancel a customer's subscription and prevent future charges.
- Detach payment methodDetaches a PaymentMethod object from a Customer account. Use when you need to remove a payment method from a customer without deleting it entirely.
- Finalize an invoiceFinalize a draft invoice so it becomes open/collectable (and immutable where required). Use when you need to transition an invoice from draft to open status for payment collection.
- Update customer subscriptionTool to update a customer's subscription. Use when modifying subscription items, billing cycle, payment methods, or metadata for an existing subscription.
- Search Stripe customersTool to search for Stripe customers using a search query. Use when you need to find customers by email, name, metadata, or other fields using Stripe's Search Query Language.
- Update subscriptionUpdates an existing Stripe subscription's properties including metadata, description, payment method, billing settings, trial periods, and cancellation behavior. Use this to modify subscription config
- Update Tax RateTool to update an existing Stripe tax rate. Use when you need to modify tax rate properties such as display name, description, or active status.
- Update Charge DisputeTool to update metadata on a charge's dispute. Use when you need to attach structured information to a dispute for tracking or internal reference purposes.
- Update Charge RefundTool to update a specified refund within a charge. Use when you need to modify the metadata of an existing refund.
- Update customer cardTool to update a card for a specified customer. Use when you need to update card details including billing address, expiration, name, or metadata.
- Update customer sourceUpdate a specified source for a given customer. Use when modifying card details, bank account information, or source metadata.
- Update Customer SubscriptionTool to update a subscription on a customer in Stripe. Use when modifying subscription items, billing settings, payment methods, or metadata. Requires both customer ID and subscription ID. Supports up
- Update Payment IntentUpdates a Stripe PaymentIntent with new values for specified parameters; note that if `currency` is updated, `amount` might also be required, and certain updates (e.g., to `payment_method`) can necess
- Update SubscriptionUpdates an existing, non-canceled Stripe subscription by its ID, ensuring all referenced entity IDs (e.g., prices, coupons) are valid and automatic tax liability is correctly specified if enabled.
- Void an invoiceTool to void a finalized Stripe invoice. Use when you need to mark an invoice as uncollectible while maintaining a paper trail. Voiding an invoice is permanent and cannot be undone. Only finalized inv
- Accept quoteTool to accept a quote in Stripe. Use when you need to accept a finalized quote, which will create an invoice, subscription, or subscription schedule based on the quote's configuration.
- Activate billing alertReactivates a billing alert, allowing it to trigger again. Use when you need to resume monitoring usage thresholds and receiving notifications for a previously deactivated alert.
- Advance test clockAdvance a test clock to a future timestamp. Use for testing time-based billing scenarios. Requires test mode API keys (test_helpers endpoints are only available in test mode). The advancement is async
- Apply customer balance to payment intentManually reconciles remaining amount for a customer_balance PaymentIntent by applying funds from customer's cash balance. IMPORTANT: This action only works with PaymentIntents that have 'customer_bala
- Archive billing alertTool to archive a billing alert in Stripe, removing it from list views and APIs. Use when you need to permanently archive a billing alert. This action is non-reversible.
- Attach source to customerAttach a payment source (card token or source object) to a customer for future charges. IMPORTANT: This is a legacy API. For new integrations, use the PaymentMethods API instead (STRIPE_ATTACH_PAYMENT
- Attach feature to productTool to attach a feature to a product. Use when you need to add a feature to a product's capabilities. This creates a product_feature object linking the feature to the product.
- Cancel QuoteTool to cancel a Stripe quote. Use when you need to cancel an existing quote that is in 'draft' or 'open' status. Once canceled, the quote cannot be finalized or accepted by the customer.
- Cancel setup intentCancels a SetupIntent that is no longer needed. Use when a SetupIntent is in 'requires_payment_method', 'requires_confirmation', or 'requires_action' state. Note: SetupIntents linked to Checkout Sessi
- Cancel subscription scheduleCancels a subscription schedule and its associated subscription immediately (if active). Use when you need to stop scheduling of phases while leaving any existing subscription in place. Only succeeds
- Cancel Terminal Reader ActionTool to cancel the current reader action. Use when you need to halt any ongoing operation on a Stripe Terminal reader device such as payment collection, setup intent processing, or input collection.
- Capture ChargeTool to capture payment on an uncaptured charge. Use when a charge was created with capture=false and you're ready to capture the payment.
- Close DisputeTool to close a dispute. Use when you want to dismiss a dispute and acknowledge it as lost, indicating no evidence will be submitted. This action is irreversible.
- Set Terminal Reader DisplayInitiates input collection on a Terminal Reader to display forms and collect customer information. Use when you need to gather email, phone, text, numeric, signature, or selection inputs from customer
- Collect payment method on Terminal ReaderTool to initiate payment method collection on a Stripe Terminal Reader. Use when you need to hand off a PaymentIntent to a physical card reader device to collect payment details. The Reader action exe
- Confirm setup intentConfirms a SetupIntent to complete customer payment method setup. Use when you need to finalize credential collection after creating a SetupIntent.
- Confirm PaymentIntent on Terminal ReaderTool to confirm a PaymentIntent on a Terminal reader device. Use when you need to finalize a payment transaction on a card reader after the PaymentIntent has been collected on the reader hardware.
- Create Card Payments CapabilityTool to create or update card payments capability for a Stripe Connect account. Use when you need to enable or disable card payment processing for a connected account.
- Create Account SessionCreates an Account Session for a Stripe Connect account, granting access to embedded components. Use when you need to provide temporary, client-side access to a connected account's dashboard features
- Create Apple Pay DomainTool to create an Apple Pay domain registration. Use when registering your domain with Apple Pay to accept Apple Pay payments on your website. Stripe handles the Apple merchant validation process.
- Create apps secretTool to create a secret in the Stripe Secret Store. Use when you need to securely persist secrets for use by UI Extensions and app backends.
- Create Bank Account TokenTool to create a single-use token representing bank account details. Use when you need to securely collect bank account information for ACH payments, direct debits, or adding a bank account to a custo
- Create billing alertTool to create a billing alert that monitors usage on a billing meter and triggers notifications when a specified threshold is crossed. Use when you need to set up usage-based billing alerts.
- Create Billing Meter Event SessionCreates authentication session for high-throughput meter event stream. Use when you need to send meter events to Stripe's billing system; tokens are valid for 15 minutes.
- Create Billing Portal ConfigurationTool to create a Stripe billing portal configuration. Use when you need to define the functionality and behavior of a customer portal session, including which features customers can access.
- Create Billing Portal SessionTool to create a Stripe billing portal session. Use when you need to provide customers with a secure URL to manage their subscriptions, payment methods, and invoices.
- Create CouponCreates a new discount coupon in Stripe with percentage or fixed amount discount. Use when creating promotional discounts for customers.
- Create Credit NoteIssues a credit note to adjust a finalized invoice's amount. Use when you need to credit an invoice after finalization, either for refunds, customer balance credits, or out-of-band adjustments.
- Create customer bank accountTool to create a new bank account attached to a customer object. Use when you need to add a bank account as a payment source for an existing Stripe customer.
- Create Customer SessionTool to create a Stripe Customer Session granting client-side access control over a Customer. Use when you need to provide temporary access to customer portal features.
- Create customer subscriptionTool to create a subscription for an existing customer. Use when creating a new subscription with items and prices for a specific customer.
- Create CVC Update TokenCreates a single-use token representing an updated CVC value for card payments. Use when you need to update the CVC for an existing card without collecting the full card details again.
- Create Feature EntitlementCreates a new feature entitlement in Stripe representing a monetizable ability or functionality. Use when defining features that can be assigned to products and customers.
- Create Ephemeral KeyTool to create a short-lived ephemeral API key for secure mobile SDK access to specific Stripe resources. Use when integrating with Stripe iOS, Android SDKs, or Stripe.js for Issuing Cards.
- Create File LinkTool to create a file link object that generates a shareable URL for accessing uploaded files. Use when you need to provide temporary or permanent access to a Stripe file.
- Create Financial Connections SessionTool to create a Financial Connections Session to launch the authorization flow for linking financial accounts. Use when you need to collect customer bank account information for payments or data acce
- Create FX QuoteTool to create an FX quote for currency conversion with optional rate locking. Use when you need to view current exchange rates for currency pairs or extend quoted rates for 5 minutes to 24 hours to r
- Create invoice itemTool to create an invoice item for draft invoices. Use when adding line items to customer invoices before finalization.
- Create payment method domainTool to create a payment method domain object to control where payment methods are shown. Use when registering a new web domain with Stripe to enable payment processing capabilities.
- Create PII TokenTool to create a single-use token representing PII (personally identifiable information). Use when you need to securely tokenize sensitive personal information like ID numbers for compliance or securi
- Create a planTool to create a recurring billing plan with flexible pricing configuration. Use when setting up subscription plans with defined pricing, currency, and billing intervals.
- Create Preview InvoiceTool to preview an upcoming invoice without creating it. Use when you need to show pending charges, renewal fees, discounts, and prorations before finalizing an invoice.
- Create Promotion CodeTool to create a promotion code linked to an underlying coupon. Use when you need to generate customer-redeemable codes with optional restrictions.
- Create a quoteTool to create a Stripe quote modeling prices and services for a customer. Use when you need to generate a formal quote for a customer before finalizing payment.
- Create a Report RunCreates a new report run object and begins executing the report asynchronously. Use when you need to generate Stripe reports such as balance summaries or itemized transaction reports.
- Create Setup IntentCreates a SetupIntent object to collect payment method permissions for future payments. Use when setting up payment methods for subscriptions or saving cards for later use.
- Create a shipping rateCreates a new shipping rate object that appears on Checkout Sessions for customer display. Use when defining shipping costs for products.
- Create SourceTool to create a Stripe source object for accepting payment methods. Use when you need to process payments through various payment methods like cards, bank transfers, or redirect-based payment systems
- Create subscription scheduleTool to create a new subscription schedule for managing subscription changes over time. Use when you need to schedule future subscription modifications, phase transitions, or automate subscription lif
- Create Tax CalculationCreates a Tax Calculation to compute taxes for customer purchases. Use when you need to calculate taxes for a transaction before finalizing it, such as displaying tax amounts in a shopping cart.
- Create Tax IDCreates a new tax ID for an account or customer. Use when you need to add tax identification for compliance and invoicing purposes.
- Create tax rateTool to create a new tax rate in Stripe. Use when you need to define a tax rate for invoices, subscriptions, or checkout sessions.
- Create Tax RegistrationCreates a new Tax Registration object to enable tax collection in specified jurisdictions. Use when setting up tax collection for a new country, state, or province.
- Create Tax Transaction from CalculationTool to create a Tax Transaction from a calculation before 90-day expiration. Use when you need to finalize tax calculations and create a permanent transaction record.
- Create Terminal ConfigurationCreates a new Configuration object for Stripe payment terminals with customizable settings. Use when setting up terminal readers with specific device configurations, offline settings, tipping options,
- Create Terminal Connection TokenCreates a short-lived connection token for Stripe Terminal SDK to connect to readers. Use when initializing a Terminal connection with the Stripe Terminal SDK.
- Create Terminal LocationCreates a new Terminal Location for managing Stripe Terminal readers. Use when you need to register a physical location where Terminal readers will be deployed.
- Create Terminal Onboarding LinkCreates an onboarding link for Tap to Pay on iPhone. Use when you need to generate a redirect URL for merchants to complete the Apple Terms and Conditions acceptance flow. The generated link directs m
- Create Terminal ReaderCreates and registers a new Terminal Reader to a Stripe account at a specified location. Use this to add physical card reader devices (like Stripe S700, WisePOS E) for accepting in-person payments. Th
- Create Test ClockTool to create a test clock for testing time-based scenarios in Stripe. Use when you need to simulate the passage of time for testing subscriptions, trials, or other time-dependent features.
- Create Test Confirmation Token (Test Mode Only)Creates a test mode Confirmation Token for server-side payment integration testing. Confirmation Tokens securely transport payment method details collected client-side to your server for confirming Pa
- Create CVC update tokenTool to create a single-use CVC update token for card re-collection. Use when you need to collect an updated CVC value for a saved card, typically during payment confirmation with manual confirmation_
- Create TransferCreates a transfer to move funds between Stripe accounts as part of Connect. Use when you need to move money from your platform's balance to a connected Stripe account, such as paying out to sellers o
- Create usage recordCreates a usage record for a specified subscription item and timestamp. Use when tracking customer usage for metered billing plans to accurately invoice usage-based subscriptions.
- Deactivate billing alertTool to deactivate a billing alert, preventing it from triggering. Use when you need to stop a billing alert from monitoring usage thresholds.
- Delete Apple Pay DomainTool to delete an Apple Pay domain from a Stripe account. Use when you need to remove a previously registered Apple Pay domain. This operation is permanent and cannot be undone.
- Delete apps secretTool to delete a secret from the Stripe Secret Store by name and scope. Use when you need to permanently remove a secret. Requests from UI extensions can only access account-scoped secrets or secrets
- Cancel customer subscriptionCancels a customer's subscription immediately. Customer won't be charged again, and subscription status becomes 'canceled'.
- Delete ephemeral keyImmediately invalidate an ephemeral key. Use when you need to manually expire a short-lived API key before its automatic expiration time.
- Delete product featureRemoves a feature from a product. Use when you need to delete a specific product feature attachment.
- Delete subscription discountRemoves the currently applied discount on a subscription. Use when you need to remove a discount code or promotion from an active subscription. Returns a deleted confirmation flag upon success.
- Delete tax IDDeletes an existing tax ID object. Use when you need to permanently remove a tax identification from Stripe.
- Delete Terminal ConfigurationPermanently deletes a Terminal Configuration object from your Stripe account. Use when you need to remove a configuration that defines how features should be configured for terminal readers.
- Delete Terminal ReaderPermanently deletes a Terminal Reader object from your Stripe account. Use when you need to remove a reader device that is no longer in use.
- Delete test clockPermanently deletes a test clock from Stripe's test environment. Use when you need to remove test clocks used for simulating time-based features.
- Void an invoiceTool to void a finalized Stripe invoice. Use when you need to permanently mark an invoice as void to prevent any further collection attempts. This action cannot be undone.
- Detach payment from invoiceTool to detach a payment from an invoice. Use when you need to remove a payment from an invoice's list of payments. Only works with paid or canceled PaymentIntents.
- Disable Event DestinationDisables a v2 Event Destination, preventing it from receiving events. Use when you need to stop routing events to a webhook endpoint, Amazon EventBridge, or Azure Event Grid destination. This action i
- Expire billing credit grantExpires a billing credit grant immediately. Use when you need to terminate a credit grant before its natural expiration date.
- Expire Checkout SessionTool to expire an active Stripe Checkout Session. Use when you need to prevent customers from completing an open checkout session.
- Finalize quoteTool to finalize a quote in Stripe. Use when you need to transition a quote from draft status to open status, making it ready to be sent to the customer for acceptance. The quote must have a customer
- Fund Test Mode Cash BalanceTool to fund a test mode cash balance for a customer. Use when you need to simulate incoming bank transfers in test mode. This endpoint creates a test mode bank transfer that funds a customer's cash b
- Mark invoice as uncollectibleTool to mark a Stripe invoice as uncollectible for bad debt accounting purposes. Use when you need to write off an unpaid invoice that is unlikely to be collected.
- Migrate subscription to flexible billingMigrate a subscription from classic to flexible billing mode. Use when upgrading billing mode to enable flexible proration and invoice calculation. Requires Stripe API version 2025-06-30.basil or late
- Pay an invoiceTool to pay an invoice manually outside the normal collection schedule. Use when you need to manually trigger payment on an invoice or mark it as paid externally using paid_out_of_band parameter.
- Void billing credit grantVoids a billing credit grant, preventing it from being applied to future invoices. This operation is irreversible and marks the credit grant with a voided_at timestamp.
- Update ChargeUpdates a Stripe charge with the specified parameters; unspecified fields remain unchanged. Use when you need to modify charge details like customer association, description, fraud details, metadata,
- Verify customer bank accountVerifies a bank account for a customer using microdeposit amounts. Use when you need to confirm ownership of a bank account by providing the amounts of two microdeposits sent to the account.
- Update file linkTool to update an existing file link in Stripe. Use when you need to modify the expiration time or metadata of a file link. Note: Expired links cannot be updated.
- Void an invoiceVoids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice while preserving audit history. Only finalized invoices can be voided.
- Report Payment RecordTool to report a payment record in terminal state or for initialization. Use when you need to report payments that occurred on- or off-Stripe to create a unified payment history.
- Update setup intentUpdates a SetupIntent object to modify configuration parameters and metadata. Use when you need to update an existing SetupIntent before completion.
- Update subscription itemTool to update a subscription item's plan, quantity, billing thresholds, discounts, or metadata. Use when you need to modify an existing subscription item. Changes may trigger prorations.
- Update subscriptionTool to update an existing Stripe subscription with specified parameters. Use when you need to modify subscription items, billing settings, payment methods, or metadata for an active subscription.
- Update Terminal ConfigurationTool to update a Stripe Terminal Configuration. Use when you need to modify terminal reader settings including device-specific configurations, offline transaction capabilities, security settings, rebo
- Process payment on terminal readerInitiates a payment flow on a Stripe Terminal Reader to process a PaymentIntent. Use when you need to hand off a PaymentIntent to a physical card reader for customer payment. The reader must be online
- Set Reader DisplayConfigures a Stripe terminal reader to display cart information on screen. Use when you need to show customers their purchase details on a physical terminal device during checkout. Supported on Verifo
- Set Terminal Reader DisplayTool to configure a terminal reader's display to show cart details. Use when you need to display line items, amounts, and currency information on a Stripe Terminal reader screen.
- Update Account CapabilityUpdates an existing account capability for a Stripe connected account. Use when you need to request a new capability or remove a non-permanent capability. There may be a delay before the requested cap
- Update balance settings overviewTool to update balance settings for a Stripe account. Use when customizing payout schedules, settlement timing, or negative balance handling for a connected account.
- Update Billing Portal ConfigurationTool to update an existing billing portal configuration in Stripe. Use when you need to modify portal settings like business profile, features, or default return URL.
- Update and retrieve Checkout SessionTool to update and retrieve a Checkout Session object from Stripe. Use when you need to update metadata or other fields while retrieving the session details.
- Update Credit NoteTool to update an existing credit note in Stripe by modifying its memo or metadata. Use when you need to add context or store additional information on an already-issued credit note.
- Create or Retrieve Customer Funding InstructionsCreates or retrieves funding instructions for a customer cash balance via bank transfer. Returns bank account details (ABA, IBAN, etc.) that can be used to fund the customer's account. If funding inst
- Void an invoiceVoids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice that has not been paid. Once voided, the invoice cannot be undone and maintains audit history.
- Update Invoice Line ItemUpdates an invoice's line item before finalization. Use when you need to modify details of a line item such as description, metadata, amount, or tax settings before the invoice is finalized.
- Remove lines from invoiceTool to remove multiple line items from a draft Stripe invoice. Use when you need to delete or unassign specific line items from an invoice that hasn't been finalized yet.
- Void invoiceTool to void a finalized Stripe invoice. Use when you need to permanently void an invoice while preserving an audit trail. This operation cannot be undone and only works on finalized invoices.
- Void an invoiceTool to permanently void a finalized Stripe invoice. Use when an invoice needs to be canceled while maintaining an audit trail. This operation is irreversible and only applies to finalized invoices.
- Update Payment Method DomainUpdates an existing payment method domain to enable or disable it. Use when you need to control whether payment methods requiring domain verification will appear in Elements or Embedded Checkout.
- Report Payment AttemptTool to report a payment attempt on a Stripe Payment Record. Use when updating a Payment Record with payment attempt details such as initiation time and outcome status.
- Report Payment Attempt CanceledTool to report that the most recent payment attempt was canceled. Use when you need to update a Payment Record to reflect a canceled payment attempt.
- Report payment attempt guaranteed overviewReports that a payment attempt was guaranteed for a specific Payment Record. Use when confirming that a payment has been successfully guaranteed by the payment processor at a specific timestamp.
- Report payment attempt informationTool to report additional payment attempt information for a payment record. Use when you need to add informational details about a payment attempt.
- Report Payment Record RefundReports that the most recent payment attempt on a Payment Record was refunded. Use when you need to record a refund for a successfully processed payment to maintain accurate payment records. Multiple
- Update payout metadataUpdates a payout's metadata and returns the updated payout object. This endpoint ONLY allows updating the metadata field - no other payout properties (amount, destination, status, etc.) can be modifie
- Update Plan OverviewTool to update a Stripe plan by setting passed parameter values. Use when modifying plan details like nickname, metadata, or active status.
- Update Promotion CodeUpdates an existing promotion code. Most fields are not editable by design. Use this to activate/deactivate codes, update metadata, or modify currency-specific restrictions.
- Update Shipping RateTool to update an existing Stripe shipping rate. Use when you need to modify shipping rate properties such as active status, fixed amounts, metadata, or tax behavior.
- Update subscription scheduleTool to update an existing subscription schedule with new phases, settings, metadata, and end behavior. Use when modifying subscription schedule configuration.
- Release subscription scheduleTool to release a subscription schedule. Releases a subscription schedule immediately, stops scheduling future phases but leaves the existing subscription in place.
- Present payment method on readerTool to present a payment method on a simulated terminal reader for testing purposes. Use when testing payment flows, simulating card acceptance, or validating terminal reader integrations in test mod
- Process setup intent on terminal readerInitiates a SetupIntent flow on a Stripe Terminal Reader to save payment details. Use when you need to collect and save payment method information for future use.
- Reactivate Billing MeterReactivates a deactivated billing meter. Use when you need to resume tracking usage after a meter has been deactivated.
- Report Payment Attempt FailedReports that a recent payment attempt on a Payment Record has failed. Use when a payment attempt encounters an error to ensure Stripe has a complete view of payment flows.
- Resume subscriptionResumes a paused Stripe subscription with billing cycle and proration options. Use when a customer wants to restart payment collection on a previously paused subscription.
- Send invoice for manual paymentTool to manually send a finalized Stripe invoice to the customer outside the automatic billing schedule. Use when you need to deliver an invoice for manual payment. Note: In test mode, no emails are s
- Set reader displayConfigures a Stripe Terminal reader to display cart information on its screen. Use when you need to show transaction details to customers during checkout.
- Set terminal reader displayTool to set the display on a Stripe Terminal reader to show cart details. Use when you need to display line items, totals, and tax information on a physical terminal reader screen.
- Simulate successful input collectionSimulates successful completion of an ongoing input collection on a Terminal reader. This test helper allows you to test your integration's handling of successfully collected customer inputs (signatur
- Simulate Terminal Reader Input Collection TimeoutSimulate an input collection timeout on a Stripe Terminal reader. This test helper endpoint allows you to simulate timeout scenarios during input collection operations on Terminal readers without need
- Update Application Fee RefundUpdates an application fee refund by its fee ID and refund ID. Use this action when you need to update the metadata of an existing application fee refund. Application Fee Refund objects allow you to r
- Update billing credit grantUpdates an existing billing credit grant. Use when you need to modify the expiration time or metadata of a credit grant.
- Update Billing MeterTool to update a billing meter's display name. Use when you need to modify the name of an existing billing meter.
- Update Billing Portal ConfigurationUpdate a billing portal configuration. Use when you need to modify portal settings, business profile, or features.
- Update Cash Balance SettingsTool to update a customer's cash balance settings in Stripe. Use when you need to modify how funds transferred to a customer's cash balance are applied to payment intents and invoices.
- Update ChargeTool to update a Stripe charge object with provided parameters. Use when you need to modify charge details such as description, metadata, fraud assessment, receipt email, shipping information, or tran
- Update Checkout SessionTool to update a Stripe Checkout Session dynamically. Use when you need to modify customer information, line items, or shipping options on an existing checkout session. Line item updates require retra
- Update CouponUpdates a Stripe coupon's metadata, name, or currency options. Other coupon details (currency, duration, amount_off, percent_off) are, by design, not editable. Use when you need to modify coupon metad
- Update CustomerUpdates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged.
- Update Customer Balance TransactionUpdates an existing customer balance transaction's description and metadata. Use when you need to modify the description or add/update metadata on a customer balance transaction. Most transaction fiel
- Update customer bank accountUpdates a specified bank account for a given customer. Use when you need to modify account holder details or metadata for a customer's bank account.
- Update customer bank accountUpdates a bank account source attached to a customer. Use when you need to modify editable attributes like account holder name, type, or metadata.
- Update DisputeTool to update a Stripe dispute by submitting evidence or updating metadata. Use when responding to payment disputes to provide documentation countering the dispute claim.
- Update entitlements featureTool to update a feature's properties or deactivate it. Use when you need to modify an existing entitlements feature's metadata, name, or active status.
- Update Event DestinationUpdates a v2 Event Destination with new values for specified parameters. Use when you need to modify an event destination's name, description, enabled events, webhook URL, or metadata.
- Update External AccountUpdates the metadata, account holder name, account holder type of an external bank account or card belonging to a connected account and optionally sets it as the default for its currency. Use when you
- Update InvoiceUpdates a draft Stripe invoice. Use when modifying invoice details before finalization. Once finalized, monetary values and collection_method become immutable.
- Update invoice itemUpdates an invoice item on a draft invoice. Use when modifying invoice item properties like amount, description, discounts, or tax settings before invoice finalization.
- Bulk update invoice line itemsTool to bulk update multiple line items on a draft invoice. Use when you need to modify descriptions, amounts, quantities, discounts, or other properties of existing line items on an invoice that is s
- Update Payment LinkUpdates an existing payment link with new configuration details. Use when modifying payment link settings, tax configurations, custom fields, metadata, or post-completion behavior.
- Update Payment MethodUpdates an existing PaymentMethod object in Stripe. Use when you need to modify billing details, expiration dates, or metadata for a payment method. The payment method must be attached to a customer b
- Update a priceUpdates a Stripe price by setting passed parameter values; unspecified parameters remain unchanged. Use when you need to modify price metadata, active status, lookup key, or nickname. Note: Price amou
- Update productTool to update an existing product in Stripe. Use when you need to modify product details like name, description, pricing, or availability.
- Update Promotion CodeUpdates an existing Stripe promotion code by setting the values of the parameters passed. Use when you need to activate/deactivate a promotion code, update its metadata, or modify redemption restricti
- Update QuoteTool to update an existing Stripe quote with new values. Use when modifying quote details like description, line items, metadata, or other quote parameters.
- Update Subscription ScheduleTool to update an existing subscription schedule in Stripe. Use when you need to modify phases, default settings, metadata, or end behavior of a subscription schedule.
- Update Tax RegistrationTool to update an existing tax registration in Stripe. Use when you need to modify the active_from or expires_at fields of a registration. Registrations cannot be deleted after creation; use expires_a
- Update Tax SettingsUpdates Stripe Tax Settings parameters used in tax calculations. Use to configure default tax behavior, tax codes, and business head office location for tax purposes.
- Update Terminal LocationUpdates a Terminal Location by modifying specified parameters. Use when you need to change location details like display name, address, phone, or metadata.
- Update Terminal ReaderTool to update a Terminal Reader object by setting parameter values. Use when you need to modify the label or metadata of an existing reader device.
- Validate payment method domainTool to validate an existing payment method domain in Stripe to activate payment methods. Use when additional registration steps need to be completed before a payment method can be used in Elements or
- Verify microdeposits on setup intentVerifies microdeposits on a SetupIntent object to confirm bank account ownership. Use when customer needs to verify their bank account using either amounts or descriptor code from microdeposits.
- Verify microdeposits on payment intentVerifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code. Use after microdeposits are sent to complete bank account verification.
- Void a credit noteMarks a credit note as void. Use when you need to void a credit note and reverse its adjustments.
Changes wait in Needs you
Changes and sends in Stripe are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Stripe questions
Can an agent change data in Stripe on its own?
Not by default. Changes and sends in Stripe are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Stripe?
This connector lists 201 read actions. Reads run at once, without waiting for approval.
How does Stripe connect?
It connects with API key or OAuth 2.0. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.