Charge Failed Trigger
Triggered when a direct charge fails in Stripe's legacy Charges API
TriggerwebhookTry it
Integrate Stripe
with your AI workspace
Stripe offers online payment infrastructure, fraud prevention, and APIs enabling businesses to accept and manage payments globally
Explore Triggers and Actions
Checkout Session Completed Trigger
Triggered when a checkout session is completed in Stripe
TriggerwebhookTry it
Invoice Payment Succeeded Trigger
Triggered when an invoice payment is successful in Stripe
TriggerwebhookTry it
Payment Intent Failed Trigger
Triggered when a payment intent fails in Stripe
TriggerwebhookTry it
Product Created Trigger
Triggered when a product is created in Stripe
TriggerwebhookTry it
Subscription Added Trigger
Triggered when a subscription is added in Stripe
TriggerwebhookTry it
Subscription Deleted Trigger
Triggered when a subscription is deleted in Stripe
TriggerwebhookTry it
Accept quote
Tool 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.
ActionTry it
Activate billing alert
Reactivates 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.
ActionTry it
Add lines to invoice
Tool 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.
ActionTry it
Advance test clock
Advance 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 asynchronous; monitor the status field to track completion (status changes from 'advancing' to 'ready').
ActionTry it
Apply customer balance to payment intent
Manually 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_balance' in their payment_method_types. The customer_balance payment method type must be enabled in your Stripe account settings. Use this when you need to apply funds from a customer's cash balance account to complete or partially fund a PaymentIntent.
ActionTry it
Archive billing alert
Tool 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.
ActionTry it
Attach feature to product
Tool 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.
ActionTry it
Attach payment method to customer
Attaches 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.
ActionTry it
Attach payment to invoice
Attaches 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 associate an existing payment with a specific invoice.
ActionTry it
Attach source to customer
Attach 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_METHOD). The source parameter accepts: - Card tokens (tok_xxxx) created client-side via Stripe.js or mobile SDKs - Source objects (src_xxxx) for alternative payment methods NOTE: PaymentMethod objects (pm_xxxx) cannot be used with this endpoint. Use STRIPE_ATTACH_PAYMENT_METHOD for those. In test mode, you can use test tokens like 'tok_visa'. In live mode, tokens must be created client-side for PCI compliance.
ActionTry it
Bulk update invoice line items
Tool 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 still in draft status. This operation only works with draft invoices; finalized invoices cannot be updated using this endpoint.
ActionTry it
Cancel customer subscription
Cancels a customer's subscription immediately. Customer won't be charged again, and subscription status becomes 'canceled'.
ActionTry it
Cancel payment intent
Cancels 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_capturable will be automatically refunded.
ActionTry it
Cancel Quote
Tool 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.
ActionTry it
Cancel setup intent
Cancels 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 Sessions cannot be canceled through this method.
ActionTry it
Cancel subscription
Cancels 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.
ActionTry it
Cancel subscription
Tool to cancel a Stripe subscription immediately. Use when you need to permanently cancel a customer's subscription and prevent future charges.
ActionTry it
Cancel subscription schedule
Cancels 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 if the schedule status is 'not_started' or 'active'.
ActionTry it
Cancel Terminal Reader Action
Tool 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.
ActionTry it
Capture Charge
Tool to capture payment on an uncaptured charge. Use when a charge was created with capture=false and you're ready to capture the payment.
ActionTry it
Capture payment intent
Captures the funds of an existing uncaptured PaymentIntent. Use when the PaymentIntent status is 'requires_capture'.
ActionTry it
Close Dispute
Tool 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.
ActionTry it
Collect payment method on Terminal Reader
Tool 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 executes asynchronously with action.status showing 'in_progress' initially.
ActionTry it
Confirm payment intent
Tool 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 needs customer action like 3D Secure authentication.
ActionTry it
Confirm PaymentIntent on Terminal Reader
Tool 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.
ActionTry it
Confirm setup intent
Confirms a SetupIntent to complete customer payment method setup. Use when you need to finalize credential collection after creating a SetupIntent.
ActionTry it
Create a plan
Tool to create a recurring billing plan with flexible pricing configuration. Use when setting up subscription plans with defined pricing, currency, and billing intervals.
ActionTry it
Create a price
Creates 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`.
ActionTry it
Create a quote
Tool 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.
ActionTry it
Create a Report Run
Creates 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.
ActionTry it
Create a shipping rate
Creates a new shipping rate object that appears on Checkout Sessions for customer display. Use when defining shipping costs for products.
ActionTry it
Create an invoice
Creates 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: Stripe API enforces a maximum value of 99,999,999 (in smallest currency unit) for amount fields including `unit_amount` in invoice items, `application_fee_amount`, and `transfer_data.amount`. Values exceeding this limit will be rejected.
ActionTry it
Create Apple Pay Domain
Tool 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.
ActionTry it
Create apps secret
Tool 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.
ActionTry it
Create Bank Account Token
Tool 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 customer or recipient.
ActionTry it
Create billing alert
Tool 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.
ActionTry it
Create billing credit grant
Tool 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.
ActionTry it
Create billing meter
Tool 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 of billing calculations.
ActionTry it
Create Billing Meter Event Adjustment
Creates an adjustment to cancel a billing meter event. Use when you need to correct errors or remove events attached to the wrong customer within 24 hours of Stripe receiving them.
ActionTry it
Create Billing Meter Event Session
Creates 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.
ActionTry it
Create Billing Meter Event V2
Creates 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.
ActionTry it
Create Billing Portal Configuration
Tool 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.
ActionTry it
Create Billing Portal Session
Tool 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.
ActionTry it
Create card for customer
Tool to create a new card payment source for an existing Stripe customer. Use when you need to add a credit or debit card to a customer's account for future payments.
ActionTry it
Create card or payment source
Attaches 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.
ActionTry it
Create Card Payments Capability
Tool 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.
ActionTry it
Create charge (deprecated)
Tool to create a charge to request payment from a credit or debit card. Use when you need to charge a payment source directly. Note: This method is deprecated; Stripe recommends using the Payment Intents API instead for new integrations.
ActionTry it
Create Charge Refund
Tool to create a refund for a charge in Stripe. Use when you need to refund a previously created charge fully or partially.
ActionTry it
Create Checkout Session
Tool to create a Stripe Checkout Session. Use when you need a secure, hosted URL to collect payments or subscriptions via Stripe Checkout.
ActionTry it
Create Coupon
Creates a new discount coupon in Stripe with percentage or fixed amount discount. Use when creating promotional discounts for customers.
ActionTry it
Create Credit Note
Issues 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.
ActionTry it
Create Customer
Creates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications.
ActionTry it
Create Customer Balance Transaction
Tool 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.
ActionTry it
Create customer bank account
Tool 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.
ActionTry it
Create Customer Session
Tool 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.
ActionTry it
Create customer subscription
Tool to create a subscription for an existing customer. Use when creating a new subscription with items and prices for a specific customer.
ActionTry it
Create Customer Tax ID
Creates 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.
ActionTry it
Create CVC Update Token
Creates 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.
ActionTry it
Create CVC update token
Tool 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_method on a PaymentIntent.
ActionTry it
Create Ephemeral Key
Tool 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.
ActionTry it
Create Feature Entitlement
Creates a new feature entitlement in Stripe representing a monetizable ability or functionality. Use when defining features that can be assigned to products and customers.
ActionTry it
Create File
Tool to upload a file to Stripe for business purposes such as dispute evidence, identity verification, or business logos. Use when you need to store files that can be attached to other Stripe objects.
ActionTry it
Create File Link
Tool 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.
ActionTry it
Create Financial Connections Session
Tool 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 access.
ActionTry it
Create FX Quote
Tool 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 reduce FX fluctuation uncertainty.
ActionTry it
Create invoice item
Tool to create an invoice item for draft invoices. Use when adding line items to customer invoices before finalization.
ActionTry it
Create Meter Event Adjustment
Creates a billing meter event adjustment to cancel a previously sent meter event. Use when you need to cancel a meter event within 24 hours of Stripe receiving it.
ActionTry it
Create or Retrieve Customer Funding Instructions
Creates 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 instructions already exist for the customer, the same instructions will be returned.
ActionTry it
Create payment intent
Creates a Stripe PaymentIntent to initiate and process a customer's payment; using `application_fee_amount` for a connected account requires the `Stripe-Account` header.
ActionTry it
Create Payment Link
Tool 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. Supports up to 20 line items per payment link.
ActionTry it
Create payment method
Creates 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 PaymentIntents to collect payments - Stored for recurring payments or subscriptions The 'type' parameter determines which payment-specific fields are required: - type='card': requires card object with number, exp_month, exp_year - type='sepa_debit': requires sepa_debit object with iban - type='us_bank_account': requires us_bank_account object with account details - And many other payment method types (acss_debit, au_becs_debit, bacs_debit, boleto, etc.) IMPORTANT: For card payments, collecting card numbers directly via API requires PCI compliance and special account permissions. Consider using Stripe.js, Stripe Elements, or mobile SDKs instead for better security and easier PCI compliance. This action is most useful for non-card payment methods or when you have explicit authorization for raw card data access.
ActionTry it
Create payment method configuration
Creates a payment method configuration to control which payment methods are displayed during checkout. Use when setting up payment options for customers.
ActionTry it
Create payment method domain
Tool 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.
ActionTry it
Create PII Token
Tool 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 security purposes.
ActionTry it
Create Preview Invoice
Tool 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.
ActionTry it
Create product
Creates a new product in Stripe, encoding the request as `application/x-www-form-urlencoded` by flattening nested structures.
ActionTry it
Create Promotion Code
Tool to create a promotion code linked to an underlying coupon. Use when you need to generate customer-redeemable codes with optional restrictions.
ActionTry it
Create Refund
Creates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID.
ActionTry it
Create Reversal Tax Transaction
Creates 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.
ActionTry it
Create Setup Intent
Creates 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.
ActionTry it
Create Source
Tool 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.
ActionTry it
Create subscription
Creates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options.
ActionTry it
Create subscription item
Tool 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.
ActionTry it
Create subscription schedule
Tool 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 lifecycle management.
ActionTry it
Create Tax Calculation
Creates 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.
ActionTry it
Create Tax ID
Creates a new tax ID for an account or customer. Use when you need to add tax identification for compliance and invoicing purposes.
ActionTry it
Create tax rate
Tool to create a new tax rate in Stripe. Use when you need to define a tax rate for invoices, subscriptions, or checkout sessions.
ActionTry it
Create Tax Registration
Creates 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.
ActionTry it
Create Tax Transaction from Calculation
Tool 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.
ActionTry it
Create Terminal Configuration
Creates 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, or WiFi credentials.
ActionTry it
Create Terminal Connection Token
Creates a short-lived connection token for Stripe Terminal SDK to connect to readers. Use when initializing a Terminal connection with the Stripe Terminal SDK.
ActionTry it
Create Terminal Location
Creates a new Terminal Location for managing Stripe Terminal readers. Use when you need to register a physical location where Terminal readers will be deployed.
ActionTry it
Create Terminal Onboarding Link
Creates 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 merchants through the required onboarding process.
ActionTry it
Create Terminal Reader
Creates 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. The reader must first generate a registration code (enter 0-7-1-3-9 on the device) before registering via this API. For testing purposes, use simulated readers with codes 'simulated-wpe' or 'simulated-s700' in test mode only.
ActionTry it
Create Test Clock
Tool 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.
ActionTry it
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 PaymentIntents or SetupIntents. This test helper allows you to create these tokens server-side for testing without using Stripe.js. IMPORTANT: This endpoint requires TEST MODE API keys (sk_test_...). It will fail with live mode keys. Use this only for integration testing in test mode environments. Provide either 'payment_method' (existing PM ID) or 'payment_method_data' (to create new PM).
ActionTry it
Create usage record
Creates 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.
ActionTry it
Deactivate billing alert
Tool to deactivate a billing alert, preventing it from triggering. Use when you need to stop a billing alert from monitoring usage thresholds.
ActionTry it
Deactivate Billing Meter
Deactivates a billing meter. Use when you need to stop a meter from accepting new events and prevent it from being attached to prices.
ActionTry it
Delete Apple Pay Domain
Tool 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.
ActionTry it
Delete apps secret
Tool 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 scoped to their own user.
ActionTry it
Delete coupon
Tool to delete a coupon from Stripe. Use when you need to remove a coupon code, preventing new redemptions while preserving existing customer discounts.
ActionTry it
Delete customer
Permanently 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 active subscriptions.
ActionTry it
Delete customer (Deprecated)
DEPRECATED: Use STRIPE_DELETE_CUSTOMERS_CUSTOMER instead. Permanently deletes an existing Stripe customer; this irreversible action also cancels their active subscriptions and removes all associated data.
ActionTry it
Delete customer bank account
Deletes a bank account payment source from a customer. Use when you need to remove a bank account from a customer's payment methods.
ActionTry it
Delete customer discount
Removes the currently applied discount on a customer. Use when you need to remove a coupon or promotion code discount from a customer's account.
ActionTry it
Delete customer subscription discount
Removes 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.
ActionTry it
Delete customer tax ID
Deletes a customer's tax ID object. Use when you need to remove a specific tax identification from a customer's account.
ActionTry it
Delete draft invoice
Permanently 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.
ActionTry it
Delete ephemeral key
Immediately invalidate an ephemeral key. Use when you need to manually expire a short-lived API key before its automatic expiration time.
ActionTry it
Delete invoice item
Tool to delete an invoice item from Stripe. Use when removing invoice items that are not attached to invoices or attached to draft invoices.
ActionTry it
Delete plan
Tool 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.
ActionTry it
Delete product
Delete 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.
ActionTry it
Delete product feature
Removes a feature from a product. Use when you need to delete a specific product feature attachment.
ActionTry it
Delete subscription discount
Removes 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.
ActionTry it
Delete subscription item
Deletes 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.
ActionTry it
Delete tax ID
Deletes an existing tax ID object. Use when you need to permanently remove a tax identification from Stripe.
ActionTry it
Delete Terminal Configuration
Permanently 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.
ActionTry it
Delete Terminal Location
Tool 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 permanent and irreversible.
ActionTry it
Delete Terminal Reader
Permanently deletes a Terminal Reader object from your Stripe account. Use when you need to remove a reader device that is no longer in use.
ActionTry it
Delete test clock
Permanently deletes a test clock from Stripe's test environment. Use when you need to remove test clocks used for simulating time-based features.
ActionTry it
Detach payment from invoice
Tool 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.
ActionTry it
Detach payment method
Detaches a PaymentMethod object from a Customer account. Use when you need to remove a payment method from a customer without deleting it entirely.
ActionTry it
Download Quote PDF
Tool to download the PDF for a finalized quote from Stripe. Use when you need to retrieve the PDF document of a quote that has been finalized.
ActionTry it
Expire billing credit grant
Expires a billing credit grant immediately. Use when you need to terminate a credit grant before its natural expiration date.
ActionTry it
Expire Checkout Session
Tool to expire an active Stripe Checkout Session. Use when you need to prevent customers from completing an open checkout session.
ActionTry it
Finalize an invoice
Finalize 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.
ActionTry it
Finalize quote
Tool 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 attached before it can be finalized.
ActionTry it
Find a secret by name and scope
Tool 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.
ActionTry it
Find tax association
Tool to find a tax association by PaymentIntent ID. Use when you need to retrieve tax calculation and transaction details linked to a specific payment.
ActionTry it
Fund Test Mode Cash Balance
Tool 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 balance without processing real money.
ActionTry it
Get balance settings overview
Tool 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 authenticated account.
ActionTry it
Get Billing Credit Balance Summary
Retrieves 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 credit grant, price type (metered), specific prices, or billable items. The balance summary includes one entry per currency used in the credit grants. Use Cases: - Check remaining billing credits for a customer - View credit balances for specific metered prices or products - Monitor available vs. ledger balance for billing credits - Track credit usage across different currencies
ActionTry it
Get billing portal configuration
Tool 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.
ActionTry it
Get Charge Refund Details
Tool 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.
ActionTry it
Get Checkout Session Line Items
Tool 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.
ActionTry it
Get Credit Note Lines
Retrieves 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.
ActionTry it
Get Credit Note Preview Lines
Tool 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.
ActionTry it
Get customer cash balance
Tool 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.
ActionTry it
Get customer discount
Tool to retrieve the discount currently active on a customer. Use when you need to check a customer's active discount details.
ActionTry it
Get customer subscription discount
Tool 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.
ActionTry it
Get Invoice Line Items
Tool 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.
ActionTry it
Get payment intent amount details line items
Tool 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 intent.
ActionTry it
Get payment link line items
Tool 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 link.
ActionTry it
Get Quote Computed Upfront Line Items
Tool 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.
ActionTry it
Get quote details
Tool 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.
ActionTry it
Get Quote Line Items
Tool 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.
ActionTry it
Get Radar Early Fraud Warnings
Tool 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.
ActionTry it
Get Radar Value List
Retrieves 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.
ActionTry it
Get Radar value lists overview
Tool 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.
ActionTry it
Get reporting report types overview
Tool to list all available Stripe report types. Use when you need to discover what reporting types are available for generating reports.
ActionTry it
Get Shipping Rates Overview
Tool 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.
ActionTry it
Get Tax Calculation Line Items
Retrieves 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.
ActionTry it
Get tax codes
Tool 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.
ActionTry it
Get tax rates
Tool 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.
ActionTry it
Get Tax Settings
Retrieves Tax Settings for a merchant. Use when you need to fetch the tax configuration for a Stripe account.
ActionTry it
Get tax transaction line items
Retrieves the line items of a committed standalone tax transaction. Use when you need to view detailed line-by-line breakdown of a tax transaction.
ActionTry it
List Account Capabilities
Retrieves 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.
ActionTry it
List active entitlements
Tool to retrieve active entitlements for a customer. Use when you need to check which features a customer currently has access to.
ActionTry it
List all cards
Tool to list all cards for a customer. Use when you need to retrieve payment card information for a specific customer.
ActionTry it
List all persons for an account
Retrieves 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.
ActionTry it
List Apple Pay domains
Retrieves a list of Apple Pay domains registered with Stripe. Use when you need to fetch all registered Apple Pay domains with pagination support.
ActionTry it
List Application Fees
Returns 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 pagination support.
ActionTry it
List apps secrets
Tool to list all secrets stored on the given scope. Use when you need to retrieve secrets from the Secret Store API for Stripe Apps.
ActionTry it
List Balance Transactions
Lists Stripe balance transactions sorted by creation date descending (newest first), with optional filtering by currency, type, source, or payout and pagination support. Use to retrieve transactions that have contributed to your Stripe account balance.
ActionTry it
List Balance Transactions (Deprecated)
DEPRECATED: Use STRIPE_LIST_BALANCE_TRANSACTIONS instead. Tool to retrieve a list of balance transactions for your Stripe account. Use when you need to view transaction history affecting your balance. Returns all fund movements including charges, refunds, payouts, and fees with filtering options by date, currency, type, or source.
ActionTry it
List billing alerts
Tool 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.
ActionTry it
List billing credit grants
Tool 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.
ActionTry it
List billing meters
Tool to retrieve a list of billing meters from Stripe. Use when you need to list meters with optional filtering by status and pagination support.
ActionTry it
List cash balance transactions
Tool 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 applied.
ActionTry it
List Charges
Retrieves 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 order.
ActionTry it
List Checkout Sessions
Tool 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.
ActionTry it
List Climate Orders
Tool to list all Climate order objects. Use when you need to retrieve carbon removal orders sorted by creation date with most recent first.
ActionTry it
List climate products
Tool to retrieve a list of available Stripe Climate products. Use when you need to see carbon removal offerings with pricing and supplier information.
ActionTry it
List climate suppliers
Tool 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 enhanced weathering.
ActionTry it
List country specs
Retrieves 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.
ActionTry it
List credit balance transactions
Tool 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 activity.
ActionTry it
List Credit Notes
Lists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support.
ActionTry it
List customer balance transactions
Tool 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.
ActionTry it
List customer bank accounts
Tool to fetch all bank accounts linked to a customer. Use when you need to retrieve payment source information for a specific customer.
ActionTry it
List customer payment methods
Retrieves a list of payment methods for a given customer, supporting type filtering and pagination.
ActionTry it
List customer sources
Tool to list sources for a specified customer. Use when you need to retrieve payment sources (cards) stored on a customer account.
ActionTry it
List customer subscriptions
DEPRECATED: Use STRIPE_LIST_SUBSCRIPTIONS instead. List subscriptions for a specific Stripe customer. By default returns subscriptions that have not been canceled. Use the 'status' parameter to filter by subscription status (e.g., 'active', 'all', 'canceled', 'trialing'). Returns paginated results with subscription details including items, pricing, billing cycles, and payment settings.
ActionTry it
List customer subscriptions
Tool 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 ending_before cursors.
ActionTry it
List customer tax IDs
Tool 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.
ActionTry it
List customers
Retrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination.
ActionTry it
List Disputes
Tool to list all disputes from a Stripe account. Use when you need to retrieve disputes with optional filtering by charge or payment intent.
ActionTry it
List entitlements features
Retrieves 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.
ActionTry it
List events
Retrieves a list of Stripe events from the past 30 days with filtering and pagination. Use to track API activity and monitor webhook deliveries.
ActionTry it
List file links
Tool 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.
ActionTry it
List files
Tool 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.
ActionTry it
List Financial Connections Accounts
Tool to list Financial Connections Account objects representing external financial accounts. Use when you need to retrieve accounts linked through Financial Connections.
ActionTry it
List forwarding requests
Lists 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 inserted. Use this to retrieve and audit forwarding requests, with optional filtering by creation timestamp and pagination support. Note: This API requires special account authorization. Contact Stripe support if you need access.
ActionTry it
List FX quotes
Retrieves a list of FX quotes that have been issued, with the most recent appearing first. Use for locking exchange rates for payments or transfers.
ActionTry it
List Invoice Items
Retrieves a paginated list of Stripe invoice items. Use to filter by customer, invoice, creation date, or attachment status with cursor-based pagination.
ActionTry it
List Invoice Payments
Tool to list invoice payments in Stripe with pagination and filtering options. Use when you need to retrieve payment records associated with invoices.
ActionTry it
List Invoice Payments
Tool 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.
ActionTry it
List Invoice Rendering Templates
Tool to list all invoice rendering templates ordered by creation date. Use when you need to retrieve available invoice rendering templates.
ActionTry it
List Invoices
Retrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses.
ActionTry it
List meter event summaries
Tool to retrieve billing meter event summaries for a customer within a time range. Use when you need aggregated meter event data for billing analysis.
ActionTry it
List open reviews
Retrieves 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.
ActionTry it
List Payment Attempt Records
Tool to list payment attempt records for a specified payment record. Use when you need to retrieve all attempts made to process a specific payment.
ActionTry it
List payment intents
Tool 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.
ActionTry it
List payment links
Retrieves a list of payment links from Stripe, sorted by creation date in descending order by default.
ActionTry it
List payment method configurations
Tool 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.
ActionTry it
List payment method domains
Tool 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.
ActionTry it
List payment methods
Tool 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.
ActionTry it
List Payouts
Lists 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 status.
ActionTry it
List plans
Tool to list all billing plans from Stripe account. Use when you need to retrieve plans for subscription management or display available pricing options.
ActionTry it
List portal configurations
Tool to list billing portal configurations. Use when you need to retrieve portal configurations that describe the functionality and settings of the customer portal.
ActionTry it
List prices
Tool to list Stripe prices. Use when you need to retrieve and filter price objects before processing write operations.
ActionTry it
List product features
Retrieves a list of features attached to a product. Returns a paginated list of product_feature objects representing attachments between features and products.
ActionTry it
List products
Retrieves a list of Stripe products, with optional filtering and pagination; `starting_after`/`ending_before` cursors must be valid product IDs from a previous response.
ActionTry it
List Quotes
Retrieves a list of Stripe quotes with pagination support. Use to fetch quotes by customer, status, or creation date.
ActionTry it
List Radar Early Fraud Warnings
Returns 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 charges to decide whether to refund them proactively.
ActionTry it
List Radar Reviews
Returns 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 pagination support.
ActionTry it
List Radar value list items
Tool 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 descending order with pagination support.
ActionTry it
List Refunds
Lists Stripe refunds, sorted by creation date descending (newest first), with optional filtering by charge or payment_intent and pagination support.
ActionTry it
List Report Runs
Lists 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.
ActionTry it
List setup attempts
Tool 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 occurred.
ActionTry it
List setup intents
Tool 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.
ActionTry it
List SetupAttempts
Tool 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.
ActionTry it
List Sigma scheduled query runs
Tool 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.
ActionTry it
List Stripe coupons
Retrieves a list of discount coupons from a Stripe account, supporting pagination via `limit`, `starting_after`, and `ending_before`.
ActionTry it
List Stripe promotion codes
Retrieves 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.
ActionTry it
List Stripe promotion codes
Tool 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 creation date.
ActionTry it
List subscription item period summaries
Tool 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-chronological order (newest first), with the first item representing the most current usage period.
ActionTry it
List subscription items
List 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 Stripe subscription, including pricing, quantities, and billing details for each item.
ActionTry it
List subscription schedules
Retrieves a list of subscription schedules with optional filtering and pagination capabilities. Use to view scheduled subscription changes for customers.
ActionTry it
List subscriptions
Retrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination.
ActionTry it
List tax codes
Retrieves a paginated list of globally available, predefined Stripe tax codes used for classifying products and services in Stripe Tax.
ActionTry it
List tax IDs
Tool to retrieve a list of tax IDs with pagination support. Use when you need to list tax IDs for accounts or customers in Stripe.
ActionTry it
List tax rates
Retrieves a list of tax rates, which are returned sorted by creation date in descending order.
ActionTry it
List tax registrations
Retrieves 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.
ActionTry it
List terminal configurations
Tool to retrieve a list of Terminal Configuration objects from Stripe. Use when you need to view all terminal configurations with optional filtering and pagination.
ActionTry it
List terminal locations
Retrieves a list of Stripe terminal locations with pagination support. Use when you need to view all terminal locations for managing physical card readers.
ActionTry it
List terminal readers
Tool to list all Stripe Terminal Readers with optional filtering. Use when you need to retrieve readers by device type, location, serial number, or status.
ActionTry it
List test clocks
Retrieves a paginated list of test clocks. Use when you need to view all test clocks for testing time-dependent functionality.
ActionTry it
List Top-ups
Tool 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.
ActionTry it
List transfers
List 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.
ActionTry it
List V2 Core Event Destinations
Retrieves 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.
ActionTry it
List v2 core events
Tool 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 the related object for full details.
ActionTry it
Mark invoice as uncollectible
Tool 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.
ActionTry it
Migrate subscription to flexible billing
Migrate 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 later.
ActionTry it
Pay an invoice
Tool 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.
ActionTry it
Present payment method on reader
Tool 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 mode.
ActionTry it
Preview Credit Note
Tool 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.
ActionTry it
Process payment on terminal reader
Initiates 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 and not currently processing another action, and the PaymentIntent must be in requires_capture or requires_payment_method state. The response returns immediately with action status 'in_progress'; poll the Reader object or use webhooks to determine completion.
ActionTry it
Process setup intent on terminal reader
Initiates 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.
ActionTry it
Reactivate Billing Meter
Reactivates a deactivated billing meter. Use when you need to resume tracking usage after a meter has been deactivated.
ActionTry it
Release subscription schedule
Tool to release a subscription schedule. Releases a subscription schedule immediately, stops scheduling future phases but leaves the existing subscription in place.
ActionTry it
Remove lines from invoice
Tool 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.
ActionTry it
Report Payment Attempt
Tool 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.
ActionTry it
Report Payment Attempt Canceled
Tool 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.
ActionTry it
Report Payment Attempt Failed
Reports 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.
ActionTry it
Report payment attempt guaranteed overview
Reports 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.
ActionTry it
Report payment attempt information
Tool to report additional payment attempt information for a payment record. Use when you need to add informational details about a payment attempt.
ActionTry it
Report Payment Record
Tool 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.
ActionTry it
Report Payment Record Refund
Reports 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 partial refunds can be reported until the full amount is refunded.
ActionTry it
Resume subscription
Resumes a paused Stripe subscription with billing cycle and proration options. Use when a customer wants to restart payment collection on a previously paused subscription.
ActionTry it
Retrieve a credit note
Retrieves a credit note by its unique identifier. Use when you need to get detailed information about a specific credit note.
ActionTry it
Retrieve a customer tax ID
Tool to retrieve a specific tax ID for a customer. Use when you need to fetch details about a customer's tax identification number.
ActionTry it
Retrieve a payout
Tool to retrieve details of an existing Stripe payout. Use when you need to get information about a specific payout by its ID.
ActionTry it
Retrieve a price
Retrieves detailed information for a specific Stripe price using its unique ID. Use when you need to fetch price details.
ActionTry it
Retrieve a product
Retrieves detailed information for an existing Stripe product using its unique product ID. Use when you need to fetch details about a specific product.
ActionTry it
Retrieve a refund
Tool to retrieve details of a specific Stripe refund by ID. Use when you need to get information about an existing refund.
ActionTry it
Retrieve a Report Run
Retrieves details of an existing Report Run object. Use when you need to check the status or retrieve results of a report run.
ActionTry it
Retrieve a report type
Tool to retrieve details of a specific Stripe report type by ID. Use when you need to get information about a specific reporting report type.
ActionTry it
Retrieve a tax rate
Tool to retrieve the details of an existing tax rate. Use when you need to fetch information about a specific tax rate by its ID.
ActionTry it
Retrieve Account
Retrieves detailed information for the authenticated Stripe account. Use when you need to access account capabilities, requirements, settings, or business profile.
ActionTry it
Retrieve Account
Retrieves 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.
ActionTry it
Retrieve Account Capability
Retrieves 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 payments.
ActionTry it
Retrieve active entitlement
Tool to retrieve an active entitlement describing customer access to a feature. Use when you need to check specific entitlement details for a customer.
ActionTry it
Retrieve an invoice payment
Tool to retrieve details of a specific Stripe invoice payment by ID. Use when you need to get information about an existing invoice payment.
ActionTry it
Retrieve Apple Pay Domain
Retrieves 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.
ActionTry it
Retrieve Balance
Retrieves the complete current balance details for the connected Stripe account.
ActionTry it
Retrieve Balance Transaction
Retrieves 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.
ActionTry it
Retrieve Billing Alert
Retrieves 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.
ActionTry it
Retrieve billing credit grant
Retrieves a billing credit grant by its unique identifier. Use when you need to get details about a specific credit grant allocation for a customer.
ActionTry it
Retrieve Billing Meter
Retrieves a billing meter by its unique identifier. Use when you need to fetch configuration details and settings for a specific billing meter.
ActionTry it
Retrieve Charge Details
Retrieves full details for an existing Stripe charge using its unique ID.
ActionTry it
Retrieve Charge Dispute
Tool to retrieve a dispute for a specified charge. Use when you need to get dispute details associated with a specific charge ID.
ActionTry it
Retrieve Checkout Session
Tool 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.
ActionTry it
Retrieve climate product
Tool 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.
ActionTry it
Retrieve climate supplier details
Retrieves detailed information about a specific Stripe Climate carbon removal supplier. Returns supplier details including name, carbon removal pathway (biomass, direct air capture, or enhanced weathering), operational locations with geographic coordinates, and additional information URL. Use this to get comprehensive details about a specific supplier after obtaining supplier IDs from the list suppliers endpoint. Note: Requires Stripe Climate access. If you receive an error about submitting an account application, the Stripe account needs to apply for Climate feature access.
ActionTry it
Retrieve Confirmation Token
Tool 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 flow.
ActionTry it
Retrieve Country Spec
Retrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies. Use when you need country-specific payment capabilities.
ActionTry it
Retrieve Coupon Details
Retrieves full details for an existing Stripe coupon using its unique ID. Use when you need to check coupon validity, discount details, or redemption limits.
ActionTry it
Retrieve credit balance transaction
Retrieves 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.
ActionTry it
Retrieve customer
Retrieves detailed information for an existing Stripe customer using their unique customer ID.
ActionTry it
Retrieve Customer Balance Transaction
Retrieves 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.
ActionTry it
Retrieve customer bank account
Retrieves details about a specific bank account stored on a Stripe customer. Use when you need to view bank account information for a customer.
ActionTry it
Retrieve customer card
Retrieves details about a specific card for a customer. Use when you need to view card information stored on a customer account.
ActionTry it
Retrieve customer cash balance transaction
Tool 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.
ActionTry it
Retrieve customer source
Tool to retrieve a specified payment source for a given customer. Use when you need to get details about a specific card, bank account, or payment source attached to a customer. Note: The Sources API is deprecated; consider using PaymentMethods API for new integrations.
ActionTry it
Retrieve customer subscription
Tool 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.
ActionTry it
Retrieve customer's payment method
Tool 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.
ActionTry it
Retrieve Dispute Details
Retrieves detailed information for an existing Stripe dispute by ID. Use when you need to get complete dispute details including evidence, status, and payment information.
ActionTry it
Retrieve entitlements feature
Tool to retrieve a feature by ID from Stripe. Use when you need to get details about a specific entitlements feature.
ActionTry it
Retrieve event
Retrieves event details for events created within the last 30 days. Use when you need to fetch webhook event information or verify event data.
ActionTry it
Retrieve File
Tool to retrieve details of an existing file object by its unique identifier. Use when you need to get information about a previously uploaded file.
ActionTry it
Retrieve file link
Retrieves the details of an existing file link. Use when you need to access file link information or verify if a link is still valid.
ActionTry it
Retrieve Financial Connections Session
Retrieves the details of a Financial Connections Session. Use when you need to check the status or details of a session.
ActionTry it
Retrieve FX Quote
Retrieve 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 fluctuations. Use this to view exchange rate details, lock status, and rate breakdowns including base rates, FX fees, and duration premiums.
ActionTry it
Retrieve Invoice
Tool to retrieve a specific invoice by ID. Use when you need to get detailed information about an existing invoice.
ActionTry it
Retrieve Invoice Item
Tool to retrieve the details of an invoice item using its unique identifier. Use when you need to fetch information about a specific invoice item.
ActionTry it
Retrieve mandate
Tool to retrieve a Stripe mandate by ID. Use when you need to get authorization details for recurring or single-use payments.
ActionTry it
Retrieve Payment Attempt Record
Tool to retrieve a specific Payment Attempt Record by ID. Use when you need to get detailed information about a particular payment attempt.
ActionTry it
Retrieve payment intent
Retrieves a PaymentIntent by its ID; `client_secret` is required if a publishable API key is used.
ActionTry it
Retrieve payment link
Tool to retrieve details of an existing Stripe payment link by ID. Use when you need to get information about a specific payment link.
ActionTry it
Retrieve payment method
Retrieves 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-specific payment information. Use this when you need to view the configuration and details of an existing payment method.
ActionTry it
Retrieve payment method configuration
Tool 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.
ActionTry it
Retrieve Payment Method Domain
Retrieves details of an existing payment method domain. Use when you need to fetch information about a specific payment method domain registered with Stripe.
ActionTry it
Retrieve Payment Record
Tool 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.
ActionTry it
Retrieve Person from Account
Retrieves 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.
ActionTry it
Retrieve plan
Tool to retrieve a specific Stripe plan by its unique identifier. Use when you need to view plan details including pricing, billing frequency, and configuration.
ActionTry it
Retrieve product feature
Retrieves a specific product feature by its ID. Use when you need to get details about a particular feature attached to a product.
ActionTry it
Retrieve Promotion Code
Tool 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.
ActionTry it
Retrieve setup intent
Retrieves details of a SetupIntent by its ID; `client_secret` is required if a publishable API key is used.
ActionTry it
Retrieve Shipping Rate
Tool 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.
ActionTry it
Retrieve source
Retrieves an existing source object. DEPRECATED: The Stripe Sources API has been deprecated. This action can only retrieve existing sources created before the API deprecation. For new integrations, use the Payment Methods API instead. Use this action when you need to fetch up-to-date information about a specific source that was previously created (e.g., to check its status, view owner information, or access transaction details).
ActionTry it
Retrieve subscription
Retrieves detailed information for an existing Stripe subscription using its unique ID.
ActionTry it
Retrieve subscription item
Retrieves detailed information for a specific subscription item using its unique ID. Use when you need to fetch subscription item details, pricing, or billing information.
ActionTry it
Retrieve subscription schedule
Retrieve a subscription schedule using its unique identifier. Use when you need to view details of an existing schedule including phases, settings, and status.
ActionTry it
Retrieve Tax Calculation
Retrieves a Tax Calculation object by its unique ID. Use when you need to access tax calculation details.
ActionTry it
Retrieve tax code
Retrieves the details of an existing tax code. Use when you need to get information about a specific tax code by its ID.
ActionTry it
Retrieve tax ID
Retrieves an account or customer tax ID object. Use when you need to get details about a specific tax identification number stored in Stripe.
ActionTry it
Retrieve tax registration
Tool 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.
ActionTry it
Retrieve Tax Transaction
Retrieves a Tax Transaction object by ID. Use when you need to fetch details about a specific tax transaction.
ActionTry it
Retrieve terminal configuration
Tool 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.
ActionTry it
Retrieve Terminal Location
Tool to retrieve a Terminal Location object by ID. Use when you need to get details about a specific terminal location for managing card readers.
ActionTry it
Retrieve Terminal Reader
Tool 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.
ActionTry it
Retrieve test clock
Tool to retrieve a test clock by ID. Use when testing billing integrations by simulating time advancement in sandbox environments.
ActionTry it
Retrieve Token
Retrieves the token with the given ID. Use when you need to verify token details or check if a token has been used.
ActionTry it
Retrieve Upcoming Invoice
Tool 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 finalized, test the effects of subscription updates including prorations, or estimate future billing.
ActionTry it
Retrieve Upcoming Invoice Line Items
Tool 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.
ActionTry it
Retrieve V2 Core Event
Retrieves 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.
ActionTry it
Search invoices
Searches 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 minute, though propagation can lag up to an hour during outages.
ActionTry it
Search payment intents
Searches for PaymentIntents using Stripe's Search Query Language. Use when you need to find payments by status, amount, customer, or other criteria.
ActionTry it
Search Stripe charges
Search charges using Stripe's Search Query Language. Use when you need to find historical charges by status, amount, customer, metadata, or other criteria.
ActionTry it
Search Stripe customers
Tool 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.
ActionTry it
Search Stripe customers
Tool 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.
ActionTry it
Search Stripe customers
Retrieves a list of Stripe customers matching a search query that adheres to Stripe's Search Query Language.
ActionTry it
Search Stripe prices
Search 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.
ActionTry it
Search Stripe products
Tool 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.
ActionTry it
Search subscriptions
Searches for subscriptions using Stripe's Search Query Language. Use when you need to find subscriptions by status, metadata, created timestamp, or canceled_at timestamp.
ActionTry it
Send invoice for manual payment
Tool 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 sent, but webhook events (invoice.sent) are still generated.
ActionTry it
Set Reader Display
Configures 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 Verifone P400, BBPOS WisePOS E, and Stripe Reader S700.
ActionTry it
Set reader display
Configures a Stripe Terminal reader to display cart information on its screen. Use when you need to show transaction details to customers during checkout.
ActionTry it
Set Terminal Reader Display
Initiates 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 customers on a physical reader.
ActionTry it
Set Terminal Reader Display
Tool 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.
ActionTry it
Set terminal reader display
Tool 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.
ActionTry it
Simulate successful input collection
Simulates 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 (signature, email, phone, etc.) without requiring physical hardware or actual customer interaction. The reader must have an active input collection in progress (initiated via collect_inputs endpoint). Note: This endpoint only works in test mode with test API keys.
ActionTry it
Simulate Terminal Reader Input Collection Timeout
Simulate 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 needing physical hardware. When called, it marks the current reader action as failed with a timeout error, useful for testing error handling in your integration. **Important**: This endpoint is ONLY available in test mode. You must use test API keys (sk_test_...) to call this endpoint. Calling with live mode keys will result in an error. Use this when testing: - Timeout error handling in your application - Input collection failure scenarios - Reader action recovery flows
ActionTry it
Update a price
Updates 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 amounts cannot be modified via API.
ActionTry it
Update Account Capability
Updates 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 capability becomes active, and the response includes any activation requirements.
ActionTry it
Update and retrieve Checkout Session
Tool 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.
ActionTry it
Update balance settings overview
Tool to update balance settings for a Stripe account. Use when customizing payout schedules, settlement timing, or negative balance handling for a connected account.
ActionTry it
Update billing credit grant
Updates an existing billing credit grant. Use when you need to modify the expiration time or metadata of a credit grant.
ActionTry it
Update Billing Meter
Tool to update a billing meter's display name. Use when you need to modify the name of an existing billing meter.
ActionTry it
Update Billing Portal Configuration
Tool 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.
ActionTry it
Update Billing Portal Configuration
Update a billing portal configuration. Use when you need to modify portal settings, business profile, or features.
ActionTry it
Update Cash Balance Settings
Tool 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.
ActionTry it
Update Charge
Updates 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, receipt email, shipping information, or transfer group.
ActionTry it
Update Charge
Tool 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 transfer group.
ActionTry it
Update Charge Dispute
Tool 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.
ActionTry it
Update Charge Refund
Tool to update a specified refund within a charge. Use when you need to modify the metadata of an existing refund.
ActionTry it
Update Checkout Session
Tool 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 retransmitting the entire array.
ActionTry it
Update Coupon
Updates 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 metadata, display name, or add new currency-specific discount amounts.
ActionTry it
Update Credit Note
Tool 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.
ActionTry it
Update Customer
Updates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged.
ActionTry it
Update Customer Balance Transaction
Updates 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 fields are immutable after creation.
ActionTry it
Update customer bank account
Updates 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.
ActionTry it
Update customer bank account
Updates a bank account source attached to a customer. Use when you need to modify editable attributes like account holder name, type, or metadata.
ActionTry it
Update customer card
Tool to update a card for a specified customer. Use when you need to update card details including billing address, expiration, name, or metadata.
ActionTry it
Update customer source
Update a specified source for a given customer. Use when modifying card details, bank account information, or source metadata.
ActionTry it
Update customer subscription
Tool to update a customer's subscription. Use when modifying subscription items, billing cycle, payment methods, or metadata for an existing subscription.
ActionTry it
Update Customer Subscription
Tool 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 updating items, metadata, billing cycle, cancellation settings, and more.
ActionTry it
Update Dispute
Tool to update a Stripe dispute by submitting evidence or updating metadata. Use when responding to payment disputes to provide documentation countering the dispute claim.
ActionTry it
Update entitlements feature
Tool 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.
ActionTry it
Update file link
Tool 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.
ActionTry it
Update Invoice
Updates a draft Stripe invoice. Use when modifying invoice details before finalization. Once finalized, monetary values and collection_method become immutable.
ActionTry it
Update invoice item
Updates an invoice item on a draft invoice. Use when modifying invoice item properties like amount, description, discounts, or tax settings before invoice finalization.
ActionTry it
Update Invoice Line Item
Updates 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.
ActionTry it
Update Payment Intent
Updates 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 necessitate re-confirmation by the customer.
ActionTry it
Update Payment Link
Updates an existing payment link with new configuration details. Use when modifying payment link settings, tax configurations, custom fields, metadata, or post-completion behavior.
ActionTry it
Update Payment Method
Updates 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 before updates can be applied.
ActionTry it
Update payment method configuration
Updates a payment method configuration to control which payment methods are displayed at checkout. Use when modifying payment method availability or display settings.
ActionTry it
Update Payment Method Domain
Updates 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.
ActionTry it
Update payout metadata
Updates 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 modified. To remove a specific metadata key, pass an empty string as its value. To clear all metadata, pass an empty dictionary. Use this when you need to attach or update custom information on an existing payout.
ActionTry it
Update Plan Overview
Tool to update a Stripe plan by setting passed parameter values. Use when modifying plan details like nickname, metadata, or active status.
ActionTry it
Update product
Tool to update an existing product in Stripe. Use when you need to modify product details like name, description, pricing, or availability.
ActionTry it
Update Promotion Code
Updates an existing promotion code. Most fields are not editable by design. Use this to activate/deactivate codes, update metadata, or modify currency-specific restrictions.
ActionTry it
Update Promotion Code
Updates 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 restrictions. Most promotion code fields are intentionally non-editable after creation.
ActionTry it
Update Quote
Tool to update an existing Stripe quote with new values. Use when modifying quote details like description, line items, metadata, or other quote parameters.
ActionTry it
Update setup intent
Updates a SetupIntent object to modify configuration parameters and metadata. Use when you need to update an existing SetupIntent before completion.
ActionTry it
Update Shipping Rate
Tool 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.
ActionTry it
Update Source
Updates a Stripe source with specified parameters. Use when you need to modify source metadata, owner information, or mandate details. NOTE: The Stripe Sources API is deprecated. Stripe recommends migrating to the Payment Methods API for new integrations. This action only works with sources created before the API deprecation.
ActionTry it
Update subscription
Tool 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.
ActionTry it
Update subscription
Updates an existing Stripe subscription's properties including metadata, description, payment method, billing settings, trial periods, and cancellation behavior. Use this to modify subscription configuration, change payment methods, update billing cycles, manage trials, or schedule cancellations. This action does not modify subscription items (prices/products) - use separate actions for that.
ActionTry it
Update Subscription
Updates 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.
ActionTry it
Update subscription item
Tool 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.
ActionTry it
Update subscription schedule
Tool to update an existing subscription schedule with new phases, settings, metadata, and end behavior. Use when modifying subscription schedule configuration.
ActionTry it
Update Subscription Schedule
Tool 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.
ActionTry it
Update Tax Rate
Tool to update an existing Stripe tax rate. Use when you need to modify tax rate properties such as display name, description, or active status.
ActionTry it
Update Tax Registration
Tool 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_at to terminate them instead.
ActionTry it
Update Tax Settings
Updates Stripe Tax Settings parameters used in tax calculations. Use to configure default tax behavior, tax codes, and business head office location for tax purposes.
ActionTry it
Update Terminal Configuration
Tool to update a Stripe Terminal Configuration. Use when you need to modify terminal reader settings including device-specific configurations, offline transaction capabilities, security settings, reboot windows, WiFi credentials, or tipping configurations. Changes can take up to 10 minutes to reflect on target readers.
ActionTry it
Update Terminal Location
Updates a Terminal Location by modifying specified parameters. Use when you need to change location details like display name, address, phone, or metadata.
ActionTry it
Update Terminal Reader
Tool 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.
ActionTry it
Validate payment method domain
Tool 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 Embedded Checkout.
ActionTry it
Verify customer bank account
Verifies 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.
ActionTry it
Verify microdeposits on payment intent
Verifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code. Use after microdeposits are sent to complete bank account verification.
ActionTry it
Verify microdeposits on setup intent
Verifies 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.
ActionTry it
Void a credit note
Marks a credit note as void. Use when you need to void a credit note and reverse its adjustments.
ActionTry it
Void an invoice
Tool 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.
ActionTry it
Void an invoice
Voids 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.
ActionTry it
Void an invoice
Voids 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.
ActionTry it
Void an invoice
Tool 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.
ActionTry it
Void an invoice
Tool 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 invoices can be voided; draft invoices should be deleted instead.
ActionTry it
Void billing credit grant
Voids 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.
ActionTry it
Void invoice
Tool 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.
ActionTry it