- Category: payment processing
- Auth: API_KEY, OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 435
- Triggers: 40
- Slug:
STRIPE - Version: 20261101_00
Frequently Asked Questions
How do I set up custom OAuth credentials for Stripe?
How do I set up custom OAuth credentials for Stripe?
Why is my Stripe trigger enabled but not receiving events?
Why is my Stripe trigger enabled but not receiving events?
Tools
Accept quote
Accept quote
Activate billing alert
Activate billing alert
Add lines to invoice
Add lines to invoice
Advance test clock
Advance test clock
STRIPE_ADVANCE_TEST_CLOCKAdvance a test clock to a future timestamp. Use for testing time-based billing scenarios. Requires test mode API keys (test_helpers endpoints are only available in test mode). The advancement is asynchronous; monitor the status field to track completion (status changes from ‘advancing’ to ‘ready’).Input Parameters
Output
Apply customer balance to payment intent
Apply customer balance to payment intent
STRIPE_APPLY_CUSTOMER_BALANCEManually 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.Input Parameters
Output
Archive billing alert
Archive billing alert
Attach source to customer
Attach source to customer
STRIPE_ATTACH_CUSTOMER_SOURCEAttach 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.Input Parameters
Output
Attach payment to invoice
Attach payment to invoice
STRIPE_ATTACH_INVOICE_PAYMENTAttaches 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.Input Parameters
Output
Attach payment method to customer
Attach payment method to customer
STRIPE_ATTACH_PAYMENT_METHODAttaches 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.Input Parameters
Output
Attach feature to product
Attach feature to product
STRIPE_ATTACH_PRODUCT_FEATURETool 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.Input Parameters
Output
Cancel payment intent
Cancel payment intent
STRIPE_CANCEL_PAYMENT_INTENTCancels a PaymentIntent when in cancelable state. Use when a PaymentIntent is no longer needed to prevent further charges. For PaymentIntents with status=‘requires_capture’, the remaining amount_capturable will be automatically refunded.Input Parameters
Output
Cancel Quote
Cancel Quote
Cancel setup intent
Cancel setup intent
STRIPE_CANCEL_SETUP_INTENTCancels a SetupIntent that is no longer needed. Use when a SetupIntent is in ‘requires_payment_method’, ‘requires_confirmation’, or ‘requires_action’ state. Note: SetupIntents linked to Checkout Sessions cannot be canceled through this method.Input Parameters
Output
Cancel subscription
Cancel subscription
STRIPE_CANCEL_SUBSCRIPTIONCancels a customer’s Stripe subscription immediately, with options to invoice for metered usage and prorate charges for unused time.Input Parameters
Output
Cancel subscription schedule
Cancel subscription schedule
STRIPE_CANCEL_SUBSCRIPTION_SCHEDULECancels a subscription schedule and its associated subscription immediately if active. Only schedules with status ‘not_started’ or ‘active’ can be canceled.Input Parameters
Output
Cancel Terminal Reader Action
Cancel Terminal Reader Action
STRIPE_CANCEL_TERMINAL_READER_ACTIONTool to cancel the current reader action. Use when you need to halt any ongoing operation on a Stripe Terminal reader device such as payment collection, setup intent processing, or input collection.Input Parameters
Output
Capture Charge
Capture Charge
STRIPE_CAPTURE_CHARGETool to capture payment on an uncaptured charge. Use when a charge was created with capture=false and you’re ready to capture the payment.Input Parameters
Output
Capture payment intent
Capture payment intent
STRIPE_CAPTURE_PAYMENT_INTENTCaptures the funds of an existing uncaptured PaymentIntent. Use when the PaymentIntent status is ‘requires_capture’.Input Parameters
Output
Close Dispute
Close Dispute
Set Terminal Reader Display
Set Terminal Reader Display
STRIPE_COLLECT_TERMINAL_READER_INPUTSInitiates 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.Input Parameters
Output
Collect payment method on Terminal Reader
Collect payment method on Terminal Reader
STRIPE_COLLECT_TERMINAL_READER_PAYMENT_METHODTool 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.Input Parameters
Output
Confirm payment intent
Confirm payment intent
STRIPE_CONFIRM_PAYMENT_INTENTTool to confirm customer intent to pay with current or provided payment method. Use when ready to finalize a PaymentIntent and initiate the payment attempt. A return_url is required if confirmation needs customer action like 3D Secure authentication.Input Parameters
Output
Confirm setup intent
Confirm setup intent
Confirm PaymentIntent on Terminal Reader
Confirm PaymentIntent on Terminal Reader
STRIPE_CONFIRM_TERMINAL_READER_PAYMENT_INTENTTool 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.Input Parameters
Output
Create Card Payments Capability
Create Card Payments Capability
STRIPE_CREATE_ACCOUNTS_CAPABILITIES_CARD_PAYMENTSUpdates the card payments capability for a Stripe Connect account, requesting or removing the capability. The response includes its status and requirements.Input Parameters
Output
Create Account Session
Create Account Session
STRIPE_CREATE_ACCOUNT_SESSIONCreates an Account Session for a Stripe Connect account, granting access to embedded components. Use when you need to provide temporary, client-side access to a connected account’s dashboard features such as account management, onboarding, payments, and payouts. The Account Session expires relatively quickly and cannot be used more than once. We recommend creating a new Account Session each time you need to display an embedded component to your user.Input Parameters
Output
Create Apple Pay Domain
Create Apple Pay Domain
STRIPE_CREATE_APPLE_PAY_DOMAINTool to create an Apple Pay domain registration. Use when registering your domain with Apple Pay to accept Apple Pay payments on your website. Stripe handles the Apple merchant validation process.Input Parameters
Output
Create apps secret
Create apps secret
STRIPE_CREATE_APPS_SECRETTool to create a secret in the Stripe Secret Store. Use when you need to securely persist secrets for use by UI Extensions and app backends.Input Parameters
Output
Create Bank Account Token
Create Bank Account Token
STRIPE_CREATE_BANK_ACCOUNT_TOKENTool to create a single-use token representing bank account details. Use when you need to securely collect bank account information for ACH payments, direct debits, or adding a bank account to a customer or recipient.Input Parameters
Output
Create billing alert
Create billing alert
STRIPE_CREATE_BILLING_ALERTTool to create a billing alert that monitors usage on a billing meter and triggers notifications when a specified threshold is crossed. Use when you need to set up usage-based billing alerts.Input Parameters
Output
Create billing credit grant
Create billing credit grant
STRIPE_CREATE_BILLING_CREDIT_GRANTTool to create a credit grant that allocates billing credits to a customer for use against metered pricing. Use when you need to provide promotional or paid credits to customers.Input Parameters
Output
Create billing meter
Create billing meter
STRIPE_CREATE_BILLING_METERTool to create a billing meter in Stripe for tracking usage events. Use when you need to set up a new meter to track API calls, storage usage, or other measurable customer actions that form the basis of billing calculations.Input Parameters
Output
Create Billing Meter Event V2
Create Billing Meter Event V2
STRIPE_CREATE_BILLING_METER_EVENTCreates 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.Input Parameters
Output
Create Billing Meter Event Adjustment
Create Billing Meter Event Adjustment
STRIPE_CREATE_BILLING_METER_EVENT_ADJUSTMENTCreates 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.Input Parameters
Output
Create Billing Meter Event Session
Create Billing Meter Event Session
Create Billing Portal Configuration
Create Billing Portal Configuration
STRIPE_CREATE_BILLING_PORTAL_CONFIGURATIONTool to create a Stripe billing portal configuration. Use when you need to define the functionality and behavior of a customer portal session, including which features customers can access.Input Parameters
Output
Create Billing Portal Session
Create Billing Portal Session
STRIPE_CREATE_BILLING_PORTAL_SESSIONTool to create a Stripe billing portal session. Use when you need to provide customers with a secure URL to manage their subscriptions, payment methods, and invoices.Input Parameters
Output
Create charge (deprecated)
Create charge (deprecated)
STRIPE_CREATE_CHARGETool 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.Input Parameters
Output
Create Charge Refund
Create Charge Refund
STRIPE_CREATE_CHARGE_REFUNDTool to create a refund for a charge in Stripe. Use when you need to refund a previously created charge fully or partially.Input Parameters
Output
Create Checkout Session
Create Checkout Session
STRIPE_CREATE_CHECKOUT_SESSIONTool to create a Stripe Checkout Session. Use when you need a secure, hosted URL to collect payments or subscriptions via Stripe Checkout.Input Parameters
Output
Create Coupon
Create Coupon
STRIPE_CREATE_COUPONCreates a new discount coupon in Stripe with percentage or fixed amount discount. Use when creating promotional discounts for customers.Input Parameters
Output
Create Credit Note
Create Credit Note
STRIPE_CREATE_CREDIT_NOTEIssues a credit note to adjust a finalized invoice’s amount. Use when you need to credit an invoice after finalization, either for refunds, customer balance credits, or out-of-band adjustments.Input Parameters
Output
Create Customer
Create Customer
STRIPE_CREATE_CUSTOMERCreates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications.Input Parameters
line1 (street address, P.O. box, or c/o), line2 (apartment, suite, unit, or building), city, state (state, province, or region), postal_code (ZIP or postal code), and country (a two-letter ISO country code, e.g., ‘US’, ‘GB’). All keys are optional. Can be provided as either a dictionary or a JSON string.Output
Create Customer Balance Transaction
Create Customer Balance Transaction
STRIPE_CREATE_CUSTOMER_BALANCE_TRANSACTIONTool to create an immutable transaction that updates the customer’s credit balance. Use when you need to manually adjust a customer’s balance, such as issuing credits or debits.Input Parameters
Output
Create customer bank account
Create customer bank account
STRIPE_CREATE_CUSTOMER_BANK_ACCOUNTTool to create a new bank account attached to a customer object. Use when you need to add a bank account as a payment source for an existing Stripe customer.Input Parameters
Output
Create customer card
Create customer card
STRIPE_CREATE_CUSTOMER_CARDCreates a card or bank account payment source for a Stripe customer. Use when you need to add a new payment method to a customer for future use. Supports both card and bank account creation. Note: To use bank accounts, the customer must be verified and have the bank_account capability enabled in their country.Input Parameters
Output
Create Customer Session
Create Customer Session
STRIPE_CREATE_CUSTOMER_SESSIONCreates a Stripe Customer Session for client-side access to configured components, such as the Payment Element or customer sheet.Input Parameters
Output
Create card or payment source
Create card or payment source
STRIPE_CREATE_CUSTOMER_SOURCEAttaches a payment source to a customer for later reuse. Use when you need to save a card, bank account, or other payment source for future charges.Input Parameters
Output
Create customer subscription
Create customer subscription
STRIPE_CREATE_CUSTOMER_SUBSCRIPTIONTool to create a subscription for an existing customer. Use when creating a new subscription with items and prices for a specific customer.Input Parameters
Output
Create Customer Tax ID
Create Customer Tax ID
STRIPE_CREATE_CUSTOMER_TAX_IDCreates a new tax ID for a customer, used for tax compliance and invoicing across 100+ supported country-specific tax ID formats. Use when you need to add tax identification to a customer account.Input Parameters
Output
Create CVC Update Token
Create CVC Update Token
STRIPE_CREATE_CVC_UPDATE_TOKENCreates a single-use token representing an updated CVC value for card payments. Use when you need to update the CVC for an existing card without collecting the full card details again.Input Parameters
Output
Create Feature Entitlement
Create Feature Entitlement
STRIPE_CREATE_ENTITLEMENT_FEATURECreates a new feature entitlement in Stripe representing a monetizable ability or functionality. Use when defining features that can be assigned to products and customers.Input Parameters
Output
Create Ephemeral Key
Create Ephemeral Key
STRIPE_CREATE_EPHEMERAL_KEYTool to create a short-lived ephemeral API key for secure mobile SDK access to specific Stripe resources. Use when integrating with Stripe iOS, Android SDKs, or Stripe.js for Issuing Cards.Input Parameters
Output
Create File
Create File
STRIPE_CREATE_FILETool 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.Input Parameters
Output
Create File Link
Create File Link
STRIPE_CREATE_FILE_LINKTool to create a file link object that generates a shareable URL for accessing uploaded files. Use when you need to provide temporary or permanent access to a Stripe file.Input Parameters
Output
Create Financial Connections Session
Create Financial Connections Session
STRIPE_CREATE_FINANCIAL_CONNECTIONS_SESSIONTool to create a Financial Connections Session to launch the authorization flow for linking financial accounts. Use when you need to collect customer bank account information for payments or data access.Input Parameters
Output
Create FX Quote
Create FX Quote
STRIPE_CREATE_FX_QUOTETool to create an FX quote for currency conversion with optional rate locking. Use when you need to view current exchange rates for currency pairs or extend quoted rates for 5 minutes to 24 hours to reduce FX fluctuation uncertainty.Input Parameters
Output
Create an invoice
Create an invoice
STRIPE_CREATE_INVOICECreates a new draft Stripe invoice for a customer; use to revise an existing invoice, bill for a specific subscription (which must belong to the customer), or apply detailed customizations. Note: 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.Input Parameters
collection_method='charge_automatically', and false for collection_method='send_invoice'.shipping_rate ID or define shipping_rate_data.collection_method is ‘send_invoice’. MUTUALLY EXCLUSIVE: Cannot be used together with due_date. Provide only ONE of these parameters - if both are provided, a validation error will be raised. RECOMMENDED APPROACH: When users specify future dates in natural language (like “due in 30 days” or “due next month”), using days_until_due is safer than converting to Unix timestamps with due_date, as it avoids potential timestamp conversion errors. EXAMPLES: - “Due in 30 days” → days_until_due: 30 - “Due next month” → days_until_due: 30 - “Due in two weeks” → days_until_due: 14 - “Net 15 terms” → days_until_due: 15default_payment_method.default_tax_rates on the Customer.Output
Create invoice item
Create invoice item
Create payment intent
Create payment intent
STRIPE_CREATE_PAYMENT_INTENTCreates a Stripe PaymentIntent to initiate and process a customer’s payment; using application_fee_amount for a connected account requires the Stripe-Account header.Input Parameters
true to attempt to confirm this PaymentIntent immediately after creation. If the payment method requires any follow-up actions (e.g., 3D Secure authentication), this PaymentIntent will transition to a status requiring further action.confirm is true and payment method requires redirection.true, payment_method must be provided and confirm must be true.confirm is true and automatic_payment_methods is not enabled, or if off_session is true.automatic_payment_methods is disabled.statement_descriptor_suffix is set.Stripe-Account header for the connected account.payment_method_types must be provided.Output
Create Payment Link
Create Payment Link
STRIPE_CREATE_PAYMENT_LINKTool to create a Stripe Payment Link. Use when you need to generate a hosted checkout page URL that can be shared with customers to collect payments without building custom checkout infrastructure. Supports up to 20 line items per payment link.Input Parameters
Output
Create payment method
Create payment method
STRIPE_CREATE_PAYMENT_METHODCreates a PaymentMethod object representing a customer’s payment instrument (card, bank account, etc.). PaymentMethods can be: - Attached to a Customer for future use - Used directly with 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.Input Parameters
Output
Create payment method configuration
Create payment method configuration
STRIPE_CREATE_PAYMENT_METHOD_CONFIGURATIONCreates a payment method configuration to control which payment methods are displayed during checkout. Use when setting up payment options for customers.Input Parameters
Output
Create payment method domain
Create payment method domain
STRIPE_CREATE_PAYMENT_METHOD_DOMAINTool to create a payment method domain object to control where payment methods are shown. Use when registering a new web domain with Stripe to enable payment processing capabilities.Input Parameters
Output
Create PII Token
Create PII Token
Create a plan
Create a plan
STRIPE_CREATE_PLANTool to create a recurring billing plan with flexible pricing configuration. Use when setting up subscription plans with defined pricing, currency, and billing intervals.Input Parameters
Output
Create Preview Invoice
Create Preview Invoice
STRIPE_CREATE_PREVIEW_INVOICETool to preview an upcoming invoice without creating it. Use when you need to show pending charges, renewal fees, discounts, and prorations before finalizing an invoice.Input Parameters
Output
Create a price
Create a price
STRIPE_CREATE_PRICECreates a new Stripe Price for a product, defining its charges (one-time or recurring) and billing scheme; requires either an existing product ID or product_data.Input Parameters
billing_scheme is ‘tiered’.tiers, custom_unit_amount, or currency_options with a unit amount for the primary currency.currency’s pricing can also be defined here.true, allows this price to overwrite an existing price with the same lookup_key. Defaults to false.unit_amount, but accepts a decimal string with up to 12 decimal places for higher precision. Required if not using tiers, custom_unit_amount, or currency_options with a unit amount for the primary currency and unit_amount is not provided.Output
Create product
Create product
STRIPE_CREATE_PRODUCTCreates a new product in Stripe, encoding the request as application/x-www-form-urlencoded by flattening nested structures.Input Parameters
Output
Create Promotion Code
Create Promotion Code
STRIPE_CREATE_PROMOTION_CODETool to create a promotion code linked to an underlying coupon. Use when you need to generate customer-redeemable codes with optional restrictions.Input Parameters
Output
Create a quote
Create a quote
STRIPE_CREATE_QUOTETool to create a Stripe quote modeling prices and services for a customer. Use when you need to generate a formal quote for a customer before finalizing payment.Input Parameters
Output
Create Refund
Create Refund
STRIPE_CREATE_REFUNDCreates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID.Input Parameters
Output
Create a Report Run
Create a Report Run
STRIPE_CREATE_REPORT_RUNCreates a new report run object and begins executing the report asynchronously. Use when you need to generate Stripe reports such as balance summaries or itemized transaction reports.Input Parameters
Output
Create Reversal Tax Transaction
Create Reversal Tax Transaction
STRIPE_CREATE_REVERSAL_TAX_TRANSACTIONCreates a reversal of an existing tax transaction. Use when you need to fully or partially reverse tax calculations, either for full refunds or specific line items.Input Parameters
Output
Create Setup Intent
Create Setup Intent
STRIPE_CREATE_SETUP_INTENTCreates a SetupIntent object to collect payment method permissions for future payments. Use when setting up payment methods for subscriptions or saving cards for later use.Input Parameters
Output
Create a shipping rate
Create a shipping rate
STRIPE_CREATE_SHIPPING_RATECreates a fixed-amount Stripe shipping rate for defining shipping costs, with a customer-facing display name.Input Parameters
Output
Create Source
Create Source
STRIPE_CREATE_SOURCETool to create a Stripe source object for accepting payment methods. Use when you need to process payments through various payment methods like cards, bank transfers, or redirect-based payment systems.Input Parameters
Output
Create subscription
Create subscription
STRIPE_CREATE_SUBSCRIPTIONCreates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options.Input Parameters
Output
Create subscription item
Create subscription item
STRIPE_CREATE_SUBSCRIPTION_ITEMTool to add a new item to an existing subscription without changing existing items. Use when adding a product or service to a customer’s subscription.Input Parameters
Output
Create subscription schedule
Create subscription schedule
Create Tax Calculation
Create Tax Calculation
STRIPE_CREATE_TAX_CALCULATIONCreates a Tax Calculation to compute taxes for customer purchases. Use when you need to calculate taxes for a transaction before finalizing it, such as displaying tax amounts in a shopping cart.Input Parameters
Output
Create Tax ID
Create Tax ID
STRIPE_CREATE_TAX_IDCreates a new tax ID for an account or customer. Use when you need to add tax identification for compliance and invoicing purposes.Input Parameters
Output
Create tax rate
Create tax rate
STRIPE_CREATE_TAX_RATETool to create a new tax rate in Stripe. Use when you need to define a tax rate for invoices, subscriptions, or checkout sessions.Input Parameters
Output
Create Tax Registration
Create Tax Registration
STRIPE_CREATE_TAX_REGISTRATIONCreates a new Tax Registration object to enable tax collection in specified jurisdictions. Use when setting up tax collection for a new country, state, or province.Input Parameters
Output
Create Tax Transaction from Calculation
Create Tax Transaction from Calculation
STRIPE_CREATE_TAX_TRANSACTION_FROM_CALCULATIONTool to create a Tax Transaction from a calculation before 90-day expiration. Use when you need to finalize tax calculations and create a permanent transaction record.Input Parameters
Output
Create Terminal Configuration
Create Terminal Configuration
STRIPE_CREATE_TERMINAL_CONFIGURATIONCreates a new Configuration object for Stripe payment terminals with customizable settings. Use when setting up terminal readers with specific device configurations, offline settings, tipping options, or WiFi credentials.Input Parameters
Output
Create Terminal Connection Token
Create Terminal Connection Token
STRIPE_CREATE_TERMINAL_CONNECTION_TOKENCreates a short-lived connection token for Stripe Terminal SDK to connect to readers. Use when initializing a Terminal connection with the Stripe Terminal SDK.Input Parameters
Output
Create Terminal Location
Create Terminal Location
STRIPE_CREATE_TERMINAL_LOCATIONCreates a new Terminal Location for managing Stripe Terminal readers. Use when you need to register a physical location where Terminal readers will be deployed.Input Parameters
Output
Create Terminal Onboarding Link
Create Terminal Onboarding Link
STRIPE_CREATE_TERMINAL_ONBOARDING_LINKCreates an onboarding link for Tap to Pay on iPhone. Use when you need to generate a redirect URL for merchants to complete the Apple Terms and Conditions acceptance flow. The generated link directs merchants through the required onboarding process.Input Parameters
Output
Create Terminal Reader
Create Terminal Reader
STRIPE_CREATE_TERMINAL_READERCreates and registers a new Terminal Reader to a Stripe account at a specified location. Use this to add physical card reader devices (like Stripe S700, WisePOS E) for accepting in-person payments. 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.Input Parameters
Output
Create Test Clock
Create Test Clock
STRIPE_CREATE_TEST_CLOCKTool to create a test clock for testing time-based scenarios in Stripe. Use when you need to simulate the passage of time for testing subscriptions, trials, or other time-dependent features.Input Parameters
Output
Create Test Confirmation Token (Test Mode Only)
Create Test Confirmation Token (Test Mode Only)
STRIPE_CREATE_TEST_CONFIRMATION_TOKENCreates 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).Input Parameters
Output
Create CVC update token
Create CVC update token
Create Transfer
Create Transfer
STRIPE_CREATE_TRANSFERCreates a transfer to move funds between Stripe accounts as part of Connect. Use when you need to move money from your platform’s balance to a connected Stripe account, such as paying out to sellers or distributing funds to connected accounts.Input Parameters
Output
Create usage record
Create usage record
STRIPE_CREATE_USAGE_RECORDCreates a legacy usage record for a specified subscription item and timestamp. The legacy UsageRecords API requires a pre-Basil Stripe API version; availability depends on the account’s API version.Input Parameters
Output
Deactivate billing alert
Deactivate billing alert
Deactivate Billing Meter
Deactivate Billing Meter
Delete Apple Pay Domain
Delete Apple Pay Domain
STRIPE_DELETE_APPLE_PAY_DOMAINTool to delete an Apple Pay domain from a Stripe account. Use when you need to remove a previously registered Apple Pay domain. This operation is permanent and cannot be undone.Input Parameters
Output
Delete apps secret
Delete apps secret
STRIPE_DELETE_APPS_SECRETTool to delete a secret from the Stripe Secret Store by name and scope. Use when you need to permanently remove a secret. Requests from UI extensions can only access account-scoped secrets or secrets scoped to their own user.Input Parameters
Output
Delete coupon
Delete coupon
STRIPE_DELETE_COUPONTool to delete a coupon from Stripe. Use when you need to remove a coupon code, preventing new redemptions while preserving existing customer discounts.Input Parameters
Output
Delete customer (Deprecated)
Delete customer (Deprecated)
STRIPE_DELETE_CUSTOMERDEPRECATED: 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.Input Parameters
Output
Delete customer bank account
Delete customer bank account
STRIPE_DELETE_CUSTOMER_BANK_ACCOUNTDeletes a bank account payment source from a customer. This action is irreversible — the bank account cannot be recovered once deleted. Use when you need to remove a bank account from a customer’s payment methods.Input Parameters
Output
Delete customer discount
Delete customer discount
STRIPE_DELETE_CUSTOMER_DISCOUNTRemoves the currently applied discount on a customer. Use when you need to remove a coupon or promotion code discount from a customer’s account.Input Parameters
Output
Delete customer
Delete customer
STRIPE_DELETE_CUSTOMERS_CUSTOMERPermanently deletes a customer and cancels active subscriptions. Use when you need to remove a customer record from your Stripe account. This operation is irreversible and automatically terminates any active subscriptions.Input Parameters
Output
Cancel customer subscription
Cancel customer subscription
STRIPE_DELETE_CUSTOMER_SUBSCRIPTIONCancels a customer’s subscription immediately. Customer won’t be charged again, and subscription status becomes ‘canceled’.Input Parameters
Output
Delete customer subscription discount
Delete customer subscription discount
STRIPE_DELETE_CUSTOMER_SUBSCRIPTION_DISCOUNTRemoves currently applied discount from a customer’s subscription. Use when you need to remove a discount code or promotion from a specific subscription belonging to a customer.Input Parameters
Output
Delete customer tax ID
Delete customer tax ID
STRIPE_DELETE_CUSTOMER_TAX_IDDeletes a customer’s tax ID object. Use when you need to remove a specific tax identification from a customer’s account.Input Parameters
Output
Delete ephemeral key
Delete ephemeral key
Delete draft invoice
Delete draft invoice
STRIPE_DELETE_INVOICEPermanently deletes a draft invoice. This action cannot be undone. Use when you need to remove a draft invoice. Finalized or subscription invoices must be voided instead.Input Parameters
Output
Delete invoice item
Delete invoice item
STRIPE_DELETE_INVOICEITEMTool to delete an invoice item from Stripe. Use when removing invoice items that are not attached to invoices or attached to draft invoices.Input Parameters
Output
Delete plan
Delete plan
Delete product
Delete product
STRIPE_DELETE_PRODUCTDelete a product. Deleting a product is only possible if it has no prices associated with it. Products with type=good cannot be deleted if they have SKUs.Input Parameters
Output
Delete product feature
Delete product feature
Delete subscription discount
Delete subscription discount
STRIPE_DELETE_SUBSCRIPTION_DISCOUNTRemoves the currently applied discount on a subscription, such as a discount code or promotion. The response may include a deletion confirmation flag.Input Parameters
Output
Delete subscription item
Delete subscription item
STRIPE_DELETE_SUBSCRIPTION_ITEMDeletes a subscription item without canceling the subscription. Use when you need to remove a specific item from a customer’s subscription while keeping the subscription active.Input Parameters
Output
Delete tax ID
Delete tax ID
Delete Terminal Configuration
Delete Terminal Configuration
STRIPE_DELETE_TERMINAL_CONFIGURATIONPermanently deletes a Terminal Configuration object from your Stripe account. Use when you need to remove a configuration that defines how features should be configured for terminal readers.Input Parameters
Output
Delete Terminal Location
Delete Terminal Location
STRIPE_DELETE_TERMINAL_LOCATIONTool to permanently delete a Terminal Location object from your Stripe account. Use when you need to remove a physical location where Terminal readers are no longer deployed. This operation is permanent and irreversible.Input Parameters
Output
Delete Terminal Reader
Delete Terminal Reader
Delete test clock
Delete test clock
STRIPE_DELETE_TEST_CLOCKPermanently deletes a test clock from Stripe’s test environment. Use when you need to remove test clocks used for simulating time-based features.Input Parameters
Output
Void an invoice
Void an invoice
STRIPE_DELETE_V1_INVOICES_VOID_AN_INVOICETool to void a finalized Stripe invoice. Use when you need to permanently mark an invoice as void to prevent any further collection attempts. This action cannot be undone.Input Parameters
Output
Cancel subscription
Cancel subscription
STRIPE_DELETEV1_SUBSCRIPTIONS_LIST_SUBSCRIPTIONSTool to cancel a Stripe subscription immediately. Use when you need to permanently cancel a customer’s subscription and prevent future charges.Input Parameters
Output
Detach payment from invoice
Detach payment from invoice
STRIPE_DETACH_PAYMENT_FROM_INVOICETool to detach a payment from an invoice. Use when you need to remove a payment from an invoice’s list of payments. Only works with paid or canceled PaymentIntents.Input Parameters
Output
Detach payment method
Detach payment method
STRIPE_DETACH_PAYMENT_METHODDetaches a PaymentMethod object from a Customer account. Use when you need to remove a payment method from a customer without deleting it entirely.Input Parameters
Output
Disable Event Destination
Disable Event Destination
STRIPE_DISABLE_EVENT_DESTINATIONDisables a v2 Event Destination, preventing it from receiving events. Use when you need to stop routing events to a webhook endpoint, Amazon EventBridge, or Azure Event Grid destination. This action is reversible by enabling the destination again.Input Parameters
Output
Download File Contents
Download File Contents
Download Quote PDF
Download Quote PDF
Expire billing credit grant
Expire billing credit grant
Expire Checkout Session
Expire Checkout Session
Finalize an invoice
Finalize an invoice
STRIPE_FINALIZE_INVOICEFinalize a draft invoice so it becomes open/collectable (and immutable where required). Use when you need to transition an invoice from draft to open status for payment collection.Input Parameters
Output
Finalize quote
Finalize quote
STRIPE_FINALIZE_QUOTETool to finalize a quote in Stripe. Use when you need to transition a quote from draft status to open status, making it ready to be sent to the customer for acceptance. The quote must have a customer attached before it can be finalized.Input Parameters
Output
Find a secret by name and scope
Find a secret by name and scope
Find tax association
Find tax association
Fund Test Mode Cash Balance
Fund Test Mode Cash Balance
STRIPE_FUND_TEST_CASH_BALANCETool to fund a test mode cash balance for a customer. Use when you need to simulate incoming bank transfers in test mode. This endpoint creates a test mode bank transfer that funds a customer’s cash balance without processing real money.Input Parameters
Output
Retrieve Account
Retrieve Account
STRIPE_GET_ACCOUNTRetrieves detailed information for the authenticated Stripe account. Use when you need to access account capabilities, requirements, settings, or business profile.Input Parameters
Output
List Account Capabilities
List Account Capabilities
STRIPE_GET_ACCOUNT_CAPABILITIESRetrieves a list of capabilities for a connected Stripe account, including their statuses and requirements. The response indicates whether more capabilities are available.Input Parameters
Output
Retrieve Account Capability
Retrieve Account Capability
STRIPE_GET_ACCOUNT_CAPABILITYRetrieves information about a specific capability for a Stripe account. Use when you need to check the status, requirements, or configuration of a capability such as card payments, transfers, or ACH payments.Input Parameters
Output
Retrieve Person from Account
Retrieve Person from Account
List all persons for an account
List all persons for an account
STRIPE_GET_ACCOUNT_PERSONSRetrieves 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.Input Parameters
Output
Retrieve Account
Retrieve Account
STRIPE_GET_ACCOUNTS_ACCOUNTRetrieves the details of a Stripe account. Use when you need to check account properties like current requirements, live charge capability, payout eligibility, business details, or verification status.Input Parameters
Output
Retrieve Account Token
Retrieve Account Token
STRIPE_GET_ACCOUNT_TOKENTool to retrieve a v2 Account Token by its ID. Use when you need to fetch details about a specific account token, including its creation time, expiration, and usage status. Account tokens are single-use tokens which tokenize company/individual/business information.Input Parameters
Output
Retrieve active entitlement
Retrieve active entitlement
STRIPE_GET_ACTIVE_ENTITLEMENTTool to retrieve an active entitlement describing customer access to a feature. Use when you need to check specific entitlement details for a customer.Input Parameters
Output
Retrieve Apple Pay Domain
Retrieve Apple Pay Domain
STRIPE_GET_APPLE_PAY_DOMAINRetrieves details about a previously registered Apple Pay domain. Use when you need to fetch information about a specific Apple Pay domain that was registered with Stripe.Input Parameters
Output
List Balance Transactions (Deprecated)
List Balance Transactions (Deprecated)
STRIPE_GET_BALANCE_HISTORYDeprecated. Lists a page of Stripe account balance transactions, including charges, refunds, payouts, and fees, with filtering by date, currency, type, or source and cursor-based pagination.Input Parameters
Output
Get balance settings overview
Get balance settings overview
STRIPE_GET_BALANCE_SETTINGSTool 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.Input Parameters
Output
Retrieve Balance Transaction
Retrieve Balance Transaction
STRIPE_GET_BALANCE_TRANSACTIONRetrieves the balance transaction with the given ID. Use when you need detailed information about a specific balance transaction including amounts, fees, availability dates, and transaction sources.Input Parameters
Output
Retrieve Billing Alert
Retrieve Billing Alert
Get Billing Credit Balance Summary
Get Billing Credit Balance Summary
STRIPE_GET_BILLING_CREDIT_BALANCE_SUMMARYRetrieves the credit balance summary for a customer in Stripe Billing. This action returns the available and ledger balances for billing credits granted to a customer. You can filter by a specific 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 currenciesInput Parameters
Output
Retrieve credit balance transaction
Retrieve credit balance transaction
STRIPE_GET_BILLING_CREDIT_BALANCE_TRANSACTIONS_IDRetrieves 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.Input Parameters
Output
List billing credit grants
List billing credit grants
STRIPE_GET_BILLING_CREDIT_GRANTSTool to retrieve a paginated list of billing credit grants. Use when you need to view credit allocations for customers, track promotional credits, or manage billing credits.Input Parameters
Output
Retrieve billing credit grant
Retrieve billing credit grant
List billing meters
List billing meters
STRIPE_GET_BILLING_METERSTool to retrieve a list of billing meters from Stripe. Use when you need to list meters with optional filtering by status and pagination support.Input Parameters
Output
Retrieve Billing Meter
Retrieve Billing Meter
List portal configurations
List portal configurations
STRIPE_GET_BILLING_PORTAL_CONFIGURATIONSTool to list billing portal configurations. Use when you need to retrieve portal configurations that describe the functionality and settings of the customer portal.Input Parameters
Output
Get billing portal configuration
Get billing portal configuration
STRIPE_GET_BILLING_PORTAL_CONFIGURATIONS_CONFIGURATIONTool to retrieve a billing portal configuration from Stripe. Use when you need to fetch details about a specific portal configuration including branding, features, and settings.Input Parameters
Output
Retrieve Charge Dispute
Retrieve Charge Dispute
Get Charge Refund Details
Get Charge Refund Details
STRIPE_GET_CHARGES_CHARGE_REFUNDS_REFUNDTool 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.Input Parameters
Output
Get Checkout Session Line Items
Get Checkout Session Line Items
STRIPE_GET_CHECKOUT_SESSIONS_SESSION_LINE_ITEMSTool to retrieve line items for a Checkout Session. Use when you need to view the items, pricing, quantities, and totals for a specific checkout session.Input Parameters
Output
Retrieve climate product
Retrieve climate product
STRIPE_GET_CLIMATE_PRODUCTS_PRODUCTTool to retrieve details of a specific Stripe Climate product. Use when you need to get information about a particular carbon removal product including pricing and supplier details.Input Parameters
Output
Retrieve climate supplier details
Retrieve climate supplier details
STRIPE_GET_CLIMATE_SUPPLIERS_SUPPLIERRetrieves 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.Input Parameters
Output
Retrieve Confirmation Token
Retrieve Confirmation Token
STRIPE_GET_CONFIRMATION_TOKENS_CONFIRMATION_TOKENTool to retrieve an existing ConfirmationToken object by its ID. Use when you need to access payment method details and customer information that were securely passed during the payment confirmation flow.Input Parameters
Output
Retrieve Country Spec
Retrieve Country Spec
STRIPE_GET_COUNTRY_SPECS_COUNTRYRetrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies. Use when you need country-specific payment capabilities.Input Parameters
Output
Retrieve Coupon Details
Retrieve Coupon Details
Get Credit Note Lines
Get Credit Note Lines
STRIPE_GET_CREDIT_NOTES_CREDIT_NOTE_LINESRetrieves the paginated list of line items for a specific credit note. Use when you need complete details of all line items associated with a credit note.Input Parameters
Output
Retrieve a credit note
Retrieve a credit note
STRIPE_GET_CREDIT_NOTES_IDRetrieves a credit note by its unique identifier. Use when you need to get detailed information about a specific credit note.Input Parameters
Output
Preview Credit Note
Preview Credit Note
STRIPE_GET_CREDIT_NOTES_PREVIEWTool 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.Input Parameters
Output
Get Credit Note Preview Lines
Get Credit Note Preview Lines
STRIPE_GET_CREDIT_NOTES_PREVIEW_LINESTool to retrieve a credit note preview’s line items from Stripe. Use when you need to see what line items would be included in a credit note before creating it.Input Parameters
Output
Retrieve customer cash balance transaction
Retrieve customer cash balance transaction
STRIPE_GET_CUSTOMERS_CASH_BALANCE_TRANSACTIONSTool 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.Input Parameters
Output
List customer balance transactions
List customer balance transactions
STRIPE_GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONSTool to list customer balance transactions that updated a customer’s balance. Use when you need to retrieve the history of balance changes for a specific customer.Input Parameters
Output
Retrieve Customer Balance Transaction
Retrieve Customer Balance Transaction
STRIPE_GET_CUSTOMERS_CUSTOMER_BALANCE_TXNS_TXNRetrieves 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.Input Parameters
Output
List customer bank accounts
List customer bank accounts
STRIPE_GET_CUSTOMERS_CUSTOMER_BANK_ACCOUNTSLists a page of bank accounts linked to a customer, with cursor-based pagination.Input Parameters
Output
Retrieve customer bank account
Retrieve customer bank account
STRIPE_GET_CUSTOMERS_CUSTOMER_BANK_ACCOUNTS_IDRetrieves details about a specific bank account stored on a Stripe customer. Use when you need to view bank account information for a customer.Input Parameters
Output
List all cards
List all cards
STRIPE_GET_CUSTOMERS_CUSTOMER_CARDSLists a page of cards for a specific customer, with cursor pagination.Input Parameters
Output
Retrieve customer card
Retrieve customer card
STRIPE_GET_CUSTOMERS_CUSTOMER_CARDS_IDRetrieves details about a specific card for a customer. Use when you need to view card information stored on a customer account.Input Parameters
Output
Get customer cash balance
Get customer cash balance
STRIPE_GET_CUSTOMERS_CUSTOMER_CASH_BALANCETool to retrieve a customer’s cash balance. Use when you need to check the current cash balance for a specific Stripe customer, including available funds by currency.Input Parameters
Output
List cash balance transactions
List cash balance transactions
STRIPE_GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONSTool to retrieve a list of cash balance transactions for a customer. Use when you need to view the history of cash balance changes for a specific Stripe customer, including funds added and payments applied.Input Parameters
Output
Get customer discount
Get customer discount
STRIPE_GET_CUSTOMERS_CUSTOMER_DISCOUNTTool to retrieve the discount currently active on a customer. Use when you need to check a customer’s active discount details.Input Parameters
Output
List customer payment methods
List customer payment methods
STRIPE_GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODSRetrieves a list of payment methods for a given customer, supporting type filtering and pagination.Input Parameters
Output
Retrieve customer's payment method
Retrieve customer's payment method
STRIPE_GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_PAYMENT_METHODTool to retrieve a specific PaymentMethod object for a given Customer. Use when you need to get detailed information about a particular payment method associated with a customer.Input Parameters
Output
List customer sources
List customer sources
STRIPE_GET_CUSTOMERS_CUSTOMER_SOURCESTool to list sources for a specified customer. Use when you need to retrieve payment sources (cards) stored on a customer account.Input Parameters
Output
Retrieve customer source
Retrieve customer source
STRIPE_GET_CUSTOMERS_CUSTOMER_SOURCES_IDTool 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.Input Parameters
Output
List customer subscriptions
List customer subscriptions
STRIPE_GET_CUSTOMERS_CUSTOMER_SUBSCRIPTIONSDEPRECATED: 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.Input Parameters
Output
Retrieve customer subscription
Retrieve customer subscription
STRIPE_GET_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_IDTool 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.Input Parameters
Output
Get customer subscription discount
Get customer subscription discount
STRIPE_GET_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_ID_DISCOUNTTool to retrieve the discount currently applied to a customer’s subscription. Use when you need to check if a subscription has an active discount and get details about the coupon or promotion code.Input Parameters
Output
List customer tax IDs
List customer tax IDs
STRIPE_GET_CUSTOMERS_CUSTOMER_TAX_IDSLists a page of tax IDs, such as VAT or GST identifiers, associated with a specific Stripe customer, with cursor pagination.Input Parameters
Output
Retrieve a customer tax ID
Retrieve a customer tax ID
List active entitlements
List active entitlements
STRIPE_GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTSTool to retrieve active entitlements for a customer. Use when you need to check which features a customer currently has access to.Input Parameters
Output
Retrieve entitlements feature
Retrieve entitlements feature
List events
List events
STRIPE_GET_EVENTSRetrieves a list of Stripe events from the past 30 days with filtering and pagination. Use to track API activity and monitor webhook deliveries.Input Parameters
Output
Retrieve event
Retrieve event
Retrieve file link
Retrieve file link
STRIPE_GET_FILE_LINKS_LINKRetrieves the details of an existing file link. Use when you need to access file link information or verify if a link is still valid.Input Parameters
Output
Retrieve File
Retrieve File
Retrieve Financial Connections Session
Retrieve Financial Connections Session
Retrieve FX Quote
Retrieve FX Quote
STRIPE_GET_FX_QUOTERetrieve a specific FX (foreign exchange) Quote by its ID. FX Quotes provide exchange rates between currencies that can be locked for a period (5 minutes to 24 hours) to protect against rate fluctuations. Use this to view exchange rate details, lock status, and rate breakdowns including base rates, FX fees, and duration premiums.Input Parameters
Output
Retrieve Invoice Item
Retrieve Invoice Item
STRIPE_GET_INVOICEITEMS_INVOICEITEMTool to retrieve the details of an invoice item using its unique identifier. Use when you need to fetch information about a specific invoice item.Input Parameters
Output
Retrieve an invoice payment
Retrieve an invoice payment
Retrieve Invoice
Retrieve Invoice
STRIPE_GET_INVOICES_INVOICETool to retrieve a specific invoice by ID. Use when you need to get detailed information about an existing invoice.Input Parameters
Output
Get Invoice Line Items
Get Invoice Line Items
STRIPE_GET_INVOICES_INVOICE_LINESTool 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.Input Parameters
Output
Retrieve Linked Account
Retrieve Linked Account
STRIPE_GET_LINKED_ACCOUNTRetrieves the details of a Linked Account object by its unique identifier. A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. Use this action when you need to view the configuration, balance, ownership, and other details of an existing Financial Connections account linked through Stripe.Input Parameters
Output
Retrieve mandate
Retrieve mandate
Get monthly recurring revenue
Get monthly recurring revenue
STRIPE_GET_MONTHLY_RECURRING_REVENUEReturn Stripe-defined MRR from active and past-due subscriptions as a historical time series. Requires Stripe Analytics API preview access; restricted API keys also need Data > Metrics > Read permission.Input Parameters
Output
Retrieve Payment Attempt Record
Retrieve Payment Attempt Record
Get payment intent amount details line items
Get payment intent amount details line items
STRIPE_GET_PAYMENT_INTENT_AMOUNT_DETAILS_LINE_ITEMSTool to retrieve paginated line items for a PaymentIntent. Use when you need to get detailed product and service information including quantities, prices, discounts, and taxes for a specific payment intent.Input Parameters
Output
Retrieve payment link
Retrieve payment link
STRIPE_GET_PAYMENT_LINKTool to retrieve details of an existing Stripe payment link by ID. Use when you need to get information about a specific payment link.Input Parameters
Output
Get payment link line items
Get payment link line items
STRIPE_GET_PAYMENT_LINKS_PAYMENT_LINK_LINE_ITEMSTool to retrieve paginated line items for a payment link. Use when you need to get detailed product and service information including quantities, prices, discounts, and taxes for a specific payment link.Input Parameters
Output
Retrieve payment method
Retrieve payment method
STRIPE_GET_PAYMENT_METHODRetrieves the details of a PaymentMethod object by its unique identifier. Returns information including the payment method type (card, us_bank_account, sepa_debit, etc.), billing details, and type-specific payment information. Use this when you need to view the configuration and details of an existing payment method.Input Parameters
Output
Retrieve payment method configuration
Retrieve payment method configuration
STRIPE_GET_PAYMENT_METHOD_CONFIGURATIONTool to retrieve a specific payment method configuration by its unique identifier. Use when you need to inspect the settings and availability of payment methods for a given configuration.Input Parameters
Output
Retrieve Payment Method Domain
Retrieve Payment Method Domain
STRIPE_GET_PAYMENT_METHOD_DOMAINRetrieves details of an existing payment method domain. Use when you need to fetch information about a specific payment method domain registered with Stripe.Input Parameters
Output
Retrieve Payment Record
Retrieve Payment Record
Retrieve a payout
Retrieve a payout
Retrieve plan
Retrieve plan
Retrieve a price
Retrieve a price
Retrieve a product
Retrieve a product
STRIPE_GET_PRODUCTS_IDRetrieves detailed information for an existing Stripe product using its unique product ID. Use when you need to fetch details about a specific product.Input Parameters
Output
Retrieve product feature
Retrieve product feature
List Stripe promotion codes
List Stripe promotion codes
STRIPE_GET_PROMOTION_CODESRetrieves a list of promotion codes from a Stripe account with optional filters for active status, code value, coupon association, and customer restrictions. Supports cursor-based pagination.Input Parameters
Output
Get quote details
Get quote details
STRIPE_GET_QUOTES_QUOTETool 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.Input Parameters
Output
Get Quote Computed Upfront Line Items
Get Quote Computed Upfront Line Items
STRIPE_GET_QUOTES_QUOTE_COMPUTED_UPFRONT_LINE_ITEMSTool to retrieve computed upfront line items for a quote. Use when you need the full paginated list of upfront line items with detailed pricing information including amounts, taxes, and discounts.Input Parameters
Output
Get Quote Line Items
Get Quote Line Items
STRIPE_GET_QUOTES_QUOTE_LINE_ITEMSTool to retrieve a paginated list of line items for a quote. Use when you need to get details about the items included in a specific Stripe quote.Input Parameters
Output
Get Radar Value List
Get Radar Value List
List Radar value list items
List Radar value list items
STRIPE_GET_RADAR_VALUE_LIST_ITEMSTool to list all value list items from a Stripe Radar value list. Use when you need to retrieve items from a specific value list for fraud detection rules. Returns items sorted by creation date in descending order with pagination support.Input Parameters
Output
Retrieve a refund
Retrieve a refund
Retrieve a Report Run
Retrieve a Report Run
Retrieve a report type
Retrieve a report type
List setup attempts
List setup attempts
STRIPE_GET_SETUP_ATTEMPTSLists a page of SetupAttempts associated with a specific SetupIntent, with pagination support. Use it to examine the payment method setup process and any errors.Input Parameters
Output
Retrieve setup intent
Retrieve setup intent
Retrieve Shipping Rate
Retrieve Shipping Rate
Retrieve source
Retrieve source
STRIPE_GET_SOURCES_SOURCERetrieves 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).Input Parameters
Output
Retrieve subscription
Retrieve subscription
Retrieve subscription item
Retrieve subscription item
Retrieve subscription schedule
Retrieve subscription schedule
STRIPE_GET_SUBSCRIPTION_SCHEDULES_SCHEDULERetrieve a subscription schedule using its unique identifier. Use when you need to view details of an existing schedule including phases, settings, and status.Input Parameters
Output
Retrieve Tax Calculation
Retrieve Tax Calculation
Get Tax Calculation Line Items
Get Tax Calculation Line Items
STRIPE_GET_TAX_CALCULATIONS_CALCULATION_LINE_ITEMSRetrieves line items of a tax calculation as a paginated collection. Use this to see detailed tax information for each item in the calculation, including amounts, tax breakdowns, and tax rates.Input Parameters
Output
Retrieve tax code
Retrieve tax code
Retrieve tax ID
Retrieve tax ID
Retrieve a tax rate
Retrieve a tax rate
Retrieve tax registration
Retrieve tax registration
Get Tax Settings
Get Tax Settings
STRIPE_GET_TAX_SETTINGSRetrieves Tax Settings for a merchant. Use when you need to fetch the tax configuration for a Stripe account.Input Parameters
Output
Retrieve Tax Transaction
Retrieve Tax Transaction
Get tax transaction line items
Get tax transaction line items
STRIPE_GET_TAX_TRANSACTIONS_TRANSACTION_LINE_ITEMSRetrieves the line items of a committed standalone tax transaction. Use when you need to view detailed line-by-line breakdown of a tax transaction.Input Parameters
Output
Retrieve terminal configuration
Retrieve terminal configuration
STRIPE_GET_TERMINAL_CONFIGURATIONTool to retrieve a specific Terminal Configuration object from Stripe. Use when you need to view the detailed settings for a specific terminal configuration by its ID.Input Parameters
Output
Retrieve Terminal Location
Retrieve Terminal Location
STRIPE_GET_TERMINAL_LOCATIONTool to retrieve a Terminal Location object by ID. Use when you need to get details about a specific terminal location for managing card readers.Input Parameters
Output
Retrieve Terminal Reader
Retrieve Terminal Reader
STRIPE_GET_TERMINAL_READERTool to retrieve a Terminal Reader object by ID. Use when you need to get details about a specific reader device for accepting payment details in Stripe Terminal.Input Parameters
Output
Retrieve test clock
Retrieve test clock
Retrieve Token
Retrieve Token
Retrieve transfer reversal
Retrieve transfer reversal
STRIPE_GET_TRANSFER_REVERSALRetrieves a transfer reversal by its ID and the associated transfer ID. Use to inspect its amount and other details.Input Parameters
Output
Retrieve Upcoming Invoice Line Items
Retrieve Upcoming Invoice Line Items
STRIPE_GET_UPCOMING_INVOICE_LINE_ITEMSTool to retrieve a paginated list of line items for an upcoming invoice preview. Use when you need to see detailed line items before an invoice is finalized.Input Parameters
Output
Search Stripe customers
Search Stripe customers
STRIPE_GET_V1_CUSTOMERS_SEARCH_CUSTOMERSSearch Stripe customers using Stripe’s Search Query Language, including queries for email, metadata, and other attributes. Nonempty queries must contain a colon or tilde; this restriction also applies to creation-date comparisons.Input Parameters
Output
Retrieve Dispute Details
Retrieve Dispute Details
STRIPE_GET_V1_DISPUTES_DISPUTESRetrieves detailed information for an existing Stripe dispute by ID. Use when you need to get complete dispute details including evidence, status, and payment information.Input Parameters
Output
List Invoice Payments
List Invoice Payments
List payment method configurations
List payment method configurations
List payment method domains
List payment method domains
STRIPE_GET_V1_PAYMENT_METHOD_DOMAINSList payment method domains registered with a Stripe account, with optional filtering by domain name and enabled status. Results are paginated.Input Parameters
Output
List payment methods
List payment methods
STRIPE_GET_V1_PAYMENT_METHODS_PAYMENT_METHODS2Tool 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.Input Parameters
Output
List Radar Early Fraud Warnings
List Radar Early Fraud Warnings
STRIPE_GET_V1_RADAR_EARLY_FRAUD_WARNINGS_OVERVIEWReturns 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.Input Parameters
Output
Get Radar value lists overview
Get Radar value lists overview
STRIPE_GET_V1_RADAR_VALUE_LISTS_OVERVIEW_RADAR_VALUE_LISTSTool 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.Input Parameters
Output
Get reporting report types overview
Get reporting report types overview
Get Shipping Rates Overview
Get Shipping Rates Overview
STRIPE_GET_V1_SHIPPING_RATES_OVERVIEW2Tool 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.Input Parameters
Output
List subscription schedules
List subscription schedules
STRIPE_GET_V1_SUBSCRIPTION_SCHEDULES_OVERVIEW2Retrieves a list of subscription schedules with optional filtering and pagination capabilities. Use to view scheduled subscription changes for customers.Input Parameters
Output
Get tax codes
Get tax codes
STRIPE_GET_V1_TAX_CODES_TAX_CODE2Lists available Stripe tax codes for product classification, with pagination support.Input Parameters
Output
List tax IDs
List tax IDs
STRIPE_GET_V1_TAX_IDS_OVERVIEW2Tool to retrieve a list of tax IDs with pagination support. Use when you need to list tax IDs for accounts or customers in Stripe.Input Parameters
Output
Get tax rates
Get tax rates
STRIPE_GET_V1_TAX_RATES_TAX_RATE2Tool 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.Input Parameters
Output
Retrieve V2 Core Event
Retrieve V2 Core Event
List subscription item period summaries
List subscription item period summaries
STRIPE_LIST_ALL_SUBSCRIPTION_ITEM_PERIOD_SUMMARIESLists a page of legacy usage record summaries for a subscription item across billing periods, with cursor pagination. DEPRECATED: Stripe removed this endpoint in Basil; legacy usage requires a pre-Basil API version. Migrate to Stripe meters for usage-based billing.Input Parameters
Output
List Apple Pay domains
List Apple Pay domains
STRIPE_LIST_APPLE_PAY_DOMAINSRetrieves a list of Apple Pay domains registered with Stripe. Use when you need to fetch all registered Apple Pay domains with pagination support.Input Parameters
Output
List Application Fees
List Application Fees
STRIPE_LIST_APPLICATION_FEESReturns a list of application fees you’ve previously collected, sorted by creation date descending (newest first). Use when you need to retrieve application fees with optional filtering by charge and pagination support.Input Parameters
Output
List apps secrets
List apps secrets
STRIPE_LIST_APPS_SECRETSLists Stripe Apps Secret Store secrets in a specified scope, with cursor-based pagination.Input Parameters
Output
List Balance Transactions
List Balance Transactions
STRIPE_LIST_BALANCE_TRANSACTIONSLists a page of balance transactions for the connected Stripe account. Supports filtering by date range, currency, type, payout, or source, as well as cursor-based pagination.Input Parameters
Output
List billing alerts
List billing alerts
STRIPE_LIST_BILLING_ALERTSTool to retrieve a paginated list of billing alerts. Use when you need to view billing alerts that notify when usage thresholds on meters are crossed.Input Parameters
Output
List credit balance transactions
List credit balance transactions
List Charge Refunds
List Charge Refunds
STRIPE_LIST_CHARGE_REFUNDSLists refunds for a specific Stripe charge, ordered by creation time descending. Results are paginated and can be used to track refund history and audit transactions.Input Parameters
ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.Output
List Charges
List Charges
STRIPE_LIST_CHARGESRetrieves a list of Stripe charges with filtering and pagination; use valid cursor IDs from previous responses for pagination, and note that charges are typically returned in reverse chronological order.Input Parameters
Output
List Checkout Sessions
List Checkout Sessions
STRIPE_LIST_CHECKOUT_SESSIONSTool to retrieve a list of Stripe Checkout Sessions with pagination support. Use when you need to list checkout sessions, optionally filtering by customer, status, payment intent, or other criteria.Input Parameters
Output
List Climate Orders
List Climate Orders
STRIPE_LIST_CLIMATE_ORDERSLists Stripe Climate carbon removal orders, sorted by creation date with the most recent first. Results are paginated.Input Parameters
Output
List climate products
List climate products
STRIPE_LIST_CLIMATE_PRODUCTSLists Stripe Climate carbon removal products with supplier information and USD pricing per metric ton. Results are paginated.Input Parameters
Output
List climate suppliers
List climate suppliers
STRIPE_LIST_CLIMATE_SUPPLIERSTool to retrieve a list of available Stripe Climate supplier objects for carbon removal. Use when you need to see carbon removal providers including biomass carbon removal, direct air capture, and enhanced weathering.Input Parameters
Output
List country specs
List country specs
STRIPE_LIST_COUNTRY_SPECSRetrieves a list of country specifications available in the Stripe API. Use when you need details about supported currencies, payment methods, and verification requirements for specific countries.Input Parameters
Output
List Stripe coupons
List Stripe coupons
List Credit Notes
List Credit Notes
STRIPE_LIST_CREDIT_NOTESLists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support.Input Parameters
Output
List customers
List customers
STRIPE_LIST_CUSTOMERSRetrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination.Input Parameters
Output
List customer subscriptions
List customer subscriptions
STRIPE_LIST_CUSTOMER_SUBSCRIPTIONSTool to list all active subscriptions for a customer in Stripe. Use when you need to retrieve all subscriptions associated with a specific customer ID. Supports pagination via starting_after and ending_before cursors.Input Parameters
Output
List Disputes
List Disputes
List entitlements features
List entitlements features
STRIPE_LIST_ENTITLEMENTS_FEATURESRetrieves a paginated list of entitlements features from Stripe. Use when you need to list monetizable abilities or functionalities in your system that can be assigned to products.Input Parameters
Output
List file links
List file links
STRIPE_LIST_FILE_LINKSTool to retrieve a list of Stripe file links. Use when you need to list file links with optional filters for creation date, expiration status, and associated file.Input Parameters
Output
List files
List files
STRIPE_LIST_FILESTool to retrieve a list of files that your account has access to. Use when you need to list files uploaded to Stripe, with optional filtering by purpose or creation date.Input Parameters
Output
List Financial Connections Accounts
List Financial Connections Accounts
STRIPE_LIST_FINANCIAL_CONNECTIONS_ACCOUNTSTool to list Financial Connections Account objects representing external financial accounts. Use when you need to retrieve accounts linked through Financial Connections.Input Parameters
Output
List forwarding requests
List forwarding requests
STRIPE_LIST_FORWARDING_REQUESTSLists ForwardingRequest objects from Stripe’s Vault and Forward API. ForwardingRequests are records of requests Stripe made to third-party endpoints on your behalf, with payment card details securely 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.Input Parameters
Output
List FX quotes
List FX quotes
STRIPE_LIST_FX_QUOTESList issued FX quotes, with the most recent appearing first, for reviewing exchange rates and lock details for payments or transfers.Input Parameters
Output
List Invoice Items
List Invoice Items
STRIPE_LIST_INVOICEITEMSRetrieves a paginated list of Stripe invoice items. Use to filter by customer, invoice, creation date, or attachment status with cursor-based pagination.Input Parameters
Output
List Invoice Payments
List Invoice Payments
STRIPE_LIST_INVOICE_PAYMENTSTool to list all payments for invoices in Stripe. Use when you need to retrieve payment information associated with invoices, including pagination and filtering by invoice ID, status, or creation date.Input Parameters
Output
List Invoice Rendering Templates
List Invoice Rendering Templates
STRIPE_LIST_INVOICE_RENDERING_TEMPLATESLists invoice rendering templates ordered by creation date, with cursor-based pagination.Input Parameters
Output
List Invoices
List Invoices
STRIPE_LIST_INVOICESRetrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses.Input Parameters
Output
List meter event summaries
List meter event summaries
STRIPE_LIST_METER_EVENT_SUMMARIESTool to retrieve billing meter event summaries for a customer within a time range. Use when you need aggregated meter event data for billing analysis.Input Parameters
Output
List Payment Attempt Records
List Payment Attempt Records
List payment intents
List payment intents
STRIPE_LIST_PAYMENT_INTENTSTool to list PaymentIntents from Stripe. Use when you need to retrieve a list of payment intents with optional filtering by customer, creation date, or pagination parameters.Input Parameters
Output
List payment links
List payment links
List Payouts
List Payouts
STRIPE_LIST_PAYOUTSLists Stripe payouts sent to external accounts or received from Stripe, sorted by creation date descending (newest first), with optional filtering by arrival date, creation date, destination, and status.Input Parameters
Output
List plans
List plans
STRIPE_LIST_PLANSLists billing plans from a Stripe account, with optional filters and cursor-based pagination. Use to retrieve plans for subscription management or display pricing options.Input Parameters
Output
List prices
List prices
List products
List products
STRIPE_LIST_PRODUCTSRetrieves a list of Stripe products, with optional filtering and pagination; starting_after/ending_before cursors must be valid product IDs from a previous response.Input Parameters
True to return only active products, or False for inactive ones.{'gte': 1609459200, 'lte': 1640995200} filters for products created from January 1, 2021, to January 1, 2022.True to return only shippable products, or False for non-shippable ones.ending_before is an object ID that defines your place in the list. For instance, if a list request returns objects ending with prod_XYZ, your subsequent call can include ending_before='prod_XYZ' to fetch the previous page.starting_after is an object ID that defines your place in the list. For instance, if a list request returns objects and the last object’s ID is prod_ABC, your subsequent call can include starting_after='prod_ABC' to fetch the next page.Output
List product features
List product features
STRIPE_LIST_PRODUCTS_PRODUCT_FEATURESRetrieves a list of features attached to a product. Returns a paginated list of product_feature objects representing attachments between features and products.Input Parameters
Output
List Stripe promotion codes
List Stripe promotion codes
STRIPE_LIST_PROMOTION_CODESTool to retrieve a list of promotion codes from Stripe. Use when you need to view, filter, or paginate through promotion codes with optional filters for active status, code, coupon, customer, or creation date.Input Parameters
Output
List Quotes
List Quotes
STRIPE_LIST_QUOTESLists Stripe quotes with pagination and optional filtering by customer, customer account, status, or test clock.Input Parameters
Output
Get Radar Early Fraud Warnings
Get Radar Early Fraud Warnings
STRIPE_LIST_RADAR_EARLY_FRAUD_WARNINGSTool to list all early fraud warnings from Stripe Radar. Use when you need to retrieve fraud warnings for charges, optionally filtered by charge ID or payment intent ID.Input Parameters
Output
List Radar Reviews
List Radar Reviews
STRIPE_LIST_RADAR_REVIEWSReturns a list of Radar Review objects that have open set to true, sorted in descending order by creation date. Use when you need to retrieve reviews that require action with optional filtering and pagination support.Input Parameters
Output
List Refunds
List Refunds
List Report Runs
List Report Runs
STRIPE_LIST_REPORTING_REPORT_RUNSLists Stripe Report Runs, sorted by creation date descending (newest first). Use when you need to retrieve reporting data or check the status of report generation tasks.Input Parameters
Output
List open reviews
List open reviews
STRIPE_LIST_REVIEWSRetrieves a list of open Stripe reviews with pagination support. Use when you need to access reviews that require action, sorted by creation date with most recent first.Input Parameters
Output
List SetupAttempts
List SetupAttempts
STRIPE_LIST_SETUP_ATTEMPTSTool 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.Input Parameters
Output
List setup intents
List setup intents
STRIPE_LIST_SETUP_INTENTSTool to list SetupIntents from Stripe. Use when you need to retrieve a list of setup intents with optional filtering by customer, payment method, or pagination parameters.Input Parameters
Output
List Sigma scheduled query runs
List Sigma scheduled query runs
STRIPE_LIST_SIGMA_SCHEDULED_QUERY_RUNSLists a page of Stripe Sigma scheduled query runs, with pagination support, to check run status or access query result information.Input Parameters
ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.Output
List subscription items
List subscription items
STRIPE_LIST_SUBSCRIPTION_ITEMSLists subscription items for a given Stripe subscription, with pagination. Items include pricing, quantities, and billing details.Input Parameters
Output
List subscriptions
List subscriptions
STRIPE_LIST_SUBSCRIPTIONSRetrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination.Input Parameters
Output
List tax codes
List tax codes
List tax rates
List tax rates
STRIPE_LIST_TAX_RATESRetrieves a list of tax rates, which are returned sorted by creation date in descending order.Input Parameters
true for active tax rates and false for inactive (archived) tax rates.gt (greater than), gte (greater than or equal to), lt (less than), or lte (less than or equal to), and Unix timestamp values.true for inclusive tax rates and false for exclusive tax rates.ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include ending_before=obj_foo in order to fetch the previous page of objects.starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include starting_after=obj_bar in order to fetch the next page of objects.Output
List tax registrations
List tax registrations
STRIPE_LIST_TAX_REGISTRATIONSRetrieves a paginated list of tax registrations. Use when you need to view where a business is registered to collect tax on payments within various regions.Input Parameters
Output
List terminal configurations
List terminal configurations
STRIPE_LIST_TERMINAL_CONFIGURATIONSTool to retrieve a list of Terminal Configuration objects from Stripe. Use when you need to view all terminal configurations with optional filtering and pagination.Input Parameters
Output
List terminal locations
List terminal locations
STRIPE_LIST_TERMINAL_LOCATIONSRetrieves a list of Stripe terminal locations with pagination support. Use when you need to view all terminal locations for managing physical card readers.Input Parameters
Output
List terminal readers
List terminal readers
STRIPE_LIST_TERMINAL_READERSTool to list all Stripe Terminal Readers with optional filtering. Use when you need to retrieve readers by device type, location, serial number, or status.Input Parameters
Output
List test clocks
List test clocks
STRIPE_LIST_TEST_CLOCKSRetrieves a paginated list of test clocks. Use when you need to view all test clocks for testing time-dependent functionality.Input Parameters
Output
List Top-ups
List Top-ups
STRIPE_LIST_TOPUPSTool 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.Input Parameters
Output
List transfers
List transfers
STRIPE_LIST_TRANSFERSList all transfers sent to connected accounts. Transfers are returned in reverse chronological order. Use when you need to retrieve transfer history or monitor funds sent to connected accounts.Input Parameters
{'gte': 1609459200, 'lte': 1640995200} filters for transfers created from January 1, 2021, to January 1, 2022.ending_before is an object ID that defines your place in the list. For instance, if a list request returns objects starting with tr_XYZ, your subsequent call can include ending_before='tr_XYZ' to fetch the previous page.starting_after is an object ID that defines your place in the list. For instance, if a list request returns objects and the last object’s ID is tr_ABC, your subsequent call can include starting_after='tr_ABC' to fetch the next page.Output
List V2 Core Event Destinations
List V2 Core Event Destinations
List v2 core events
List v2 core events
STRIPE_LIST_V2_CORE_EVENTSTool to list v2 core events from Stripe. Use when you need to retrieve a list of events with thin payloads containing references to changed objects. These events are unversioned and require fetching the related object for full details.Input Parameters
Output
Mark invoice as uncollectible
Mark invoice as uncollectible
STRIPE_MARK_INVOICE_UNCOLLECTIBLETool to mark a Stripe invoice as uncollectible for bad debt accounting purposes. Use when you need to write off an unpaid invoice that is unlikely to be collected.Input Parameters
Output
Migrate subscription to flexible billing
Migrate subscription to flexible billing
STRIPE_MIGRATE_SUBSCRIPTIONMigrates a subscription from classic to flexible billing mode to enable flexible proration and invoice calculation. Requests use Stripe API version 2025-06-30.basil.Input Parameters
Output
Pay an invoice
Pay an invoice
STRIPE_PAY_INVOICETool to pay an invoice manually outside the normal collection schedule. Use when you need to manually trigger payment on an invoice or mark it as paid externally using paid_out_of_band parameter.Input Parameters
Output
Void billing credit grant
Void billing credit grant
STRIPE_POST_BILLING_CREDIT_GRANTS_VOID_CREDIT_GRANTVoids a billing credit grant, preventing it from being applied to future invoices. This operation is irreversible and marks the credit grant with a voided_at timestamp.Input Parameters
Output
Update Charge
Update Charge
STRIPE_POST_CHARGES_CHARGEUpdates a Stripe charge with the specified parameters; unspecified fields remain unchanged. Use when you need to modify charge details like customer association, description, fraud details, metadata, receipt email, shipping information, or transfer group.Input Parameters
Output
Update customer subscription
Update customer subscription
STRIPE_POST_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_IDUpdates an existing subscription’s items, billing cycle, payment methods, metadata, and other settings. The subscription ID selects the subscription; the supplied customer ID is not used to verify ownership.Input Parameters
Output
Verify customer bank account
Verify customer bank account
STRIPE_POST_CUSTOMERS_SOURCES_VERIFY_THE_BANK_ACCOUNTVerifies a bank account for a customer using microdeposit amounts. Use when you need to confirm ownership of a bank account by providing the amounts of two microdeposits sent to the account.Input Parameters
Output
Update file link
Update file link
STRIPE_POST_FILE_LINKS_LINKTool to update an existing file link in Stripe. Use when you need to modify the expiration time or metadata of a file link. Note: Expired links cannot be updated.Input Parameters
Output
Void an invoice
Void an invoice
STRIPE_POST_INVOICES_INVOICE_VOIDVoids 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.Input Parameters
Output
Report Payment Record
Report Payment Record
STRIPE_POST_PAYMENT_RECORDS_REPORT_PAYMENTTool 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.Input Parameters
Output
Update setup intent
Update setup intent
STRIPE_POST_SETUP_INTENTS_INTENTUpdates a SetupIntent object to modify configuration parameters and metadata. Use when you need to update an existing SetupIntent before completion.Input Parameters
Output
Update subscription item
Update subscription item
STRIPE_POST_SUBSCRIPTION_ITEMS_ITEMTool to update a subscription item’s plan, quantity, billing thresholds, discounts, or metadata. Use when you need to modify an existing subscription item. Changes may trigger prorations.Input Parameters
Output
Update subscription
Update subscription
STRIPE_POST_SUBSCRIPTIONS_SUBSCRIPTION_EXPOSED_IDTool 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.Input Parameters
Output
Update Terminal Configuration
Update Terminal Configuration
STRIPE_POST_TERMINAL_CONFIGURATIONS_CONFIGURATIONTool to update a Stripe Terminal Configuration. Use when you need to modify terminal reader settings including device-specific configurations, offline transaction capabilities, security settings, reboot windows, WiFi credentials, or tipping configurations. Changes can take up to 10 minutes to reflect on target readers.Input Parameters
Output
Process payment on terminal reader
Process payment on terminal reader
STRIPE_POST_TERMINAL_READERS_READER_PROCESS_PAYMENT_INTENTInitiates 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.Input Parameters
Output
Set Reader Display
Set Reader Display
STRIPE_POST_TERMINAL_READERS_READER_SET_READER_DISPLAYConfigures a Stripe terminal reader to display cart information on screen. Use when you need to show customers their purchase details on a physical terminal device during checkout. Supported on Verifone P400, BBPOS WisePOS E, and Stripe Reader S700.Input Parameters
Output
Set Terminal Reader Display
Set Terminal Reader Display
STRIPE_POST_TERMINAL_READERS_SET_READER_DISPLAYTool to configure a terminal reader’s display to show cart details. Use when you need to display line items, amounts, and currency information on a Stripe Terminal reader screen.Input Parameters
Output
Update Account Capability
Update Account Capability
STRIPE_POST_V1_ACCOUNTS_CAPABILITIES_CAPABILITIESUpdates 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.Input Parameters
Output
Update balance settings overview
Update balance settings overview
STRIPE_POST_V1_BALANCE_SETTINGS_OVERVIEWTool to update balance settings for a Stripe account. Use when customizing payout schedules, settlement timing, or negative balance handling for a connected account.Input Parameters
Output
Update Billing Portal Configuration
Update Billing Portal Configuration
STRIPE_POST_V1_BILLING_PORTAL_CONFIGS_OVERVIEW_BILLINGTool 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.Input Parameters
Output
Update and retrieve Checkout Session
Update and retrieve Checkout Session
STRIPE_POST_V1_CHECKOUT_SESSIONS_RETRIEVE_A_CHECKOUTUpdates metadata on a Stripe Checkout Session and returns the session details. Response fields can optionally be expanded.Input Parameters
Output
Update Credit Note
Update Credit Note
STRIPE_POST_V1_CREDIT_NOTES_CREDIT_NOTE2Tool 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.Input Parameters
Output
Create or Retrieve Customer Funding Instructions
Create or Retrieve Customer Funding Instructions
STRIPE_POST_V1_CUSTOMERS_FUNDING_INSTRUCTIONS_FUND_A_TESTCreates 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.Input Parameters
Output
Search Stripe customers
Search Stripe customers
STRIPE_POST_V1_CUSTOMERS_SEARCH_CUSTOMERSTool to search for Stripe customers using a search query. Use when you need to find customers by email, name, metadata, or other fields using Stripe’s Search Query Language.Input Parameters
Output
Void an invoice
Void an invoice
STRIPE_POST_V1_INVOICES_FINALIZE_VOID_AN_INVOICEVoids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice that has not been paid. Once voided, the invoice cannot be undone and maintains audit history.Input Parameters
Output
Update Invoice Line Item
Update Invoice Line Item
STRIPE_POST_V1_INVOICES_LINES_OVERVIEWUpdates 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.Input Parameters
Output
Remove lines from invoice
Remove lines from invoice
STRIPE_POST_V1_INVOICES_REMOVE_LINES_OVERVIEWTool 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.Input Parameters
Output
Void invoice
Void invoice
Void an invoice
Void an invoice
Update payment method configuration
Update payment method configuration
Update Payment Method Domain
Update Payment Method Domain
STRIPE_POST_V1_PAYMENT_METHOD_DOMAINS_PAYMENT_METHODUpdates 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.Input Parameters
Output
Report Payment Attempt
Report Payment Attempt
Report Payment Attempt Canceled
Report Payment Attempt Canceled
STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_CANCELEDTool to report that the most recent payment attempt was canceled. Use when you need to update a Payment Record to reflect a canceled payment attempt.Input Parameters
Output
Report payment attempt guaranteed overview
Report payment attempt guaranteed overview
Report payment attempt information
Report payment attempt information
Report Payment Record Refund
Report Payment Record Refund
STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_REFUND_OVERVIEWReports 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.Input Parameters
Output
Update payout metadata
Update payout metadata
STRIPE_POST_V1_PAYOUTS_RETRIEVE_A_PAYOUTUpdates an existing payout’s metadata and returns the payout object. Individual metadata keys can be removed by supplying an empty string as their value.Input Parameters
Output
Update Plan Overview
Update Plan Overview
STRIPE_POST_V1_PLANS_OVERVIEWTool to update a Stripe plan by setting passed parameter values. Use when modifying plan details like nickname, metadata, or active status.Input Parameters
Output
Update Promotion Code
Update Promotion Code
STRIPE_POST_V1_PROMOTION_CODES_PROMOTION_CODEUpdates an existing promotion code. Most fields are not editable by design. Use this to activate/deactivate codes, update metadata, or modify currency-specific restrictions.Input Parameters
Output
Update Shipping Rate
Update Shipping Rate
STRIPE_POST_V1_SHIPPING_RATES_OVERVIEW2Updates an existing Stripe shipping rate’s active status, metadata, and currency-specific fixed amounts and tax behavior.Input Parameters
Output
Update subscription schedule
Update subscription schedule
Release subscription schedule
Release subscription schedule
STRIPE_POST_V1_SUBSCRIPTION_SCHEDULES_RELEASE_OVERVIEWTool to release a subscription schedule. Releases a subscription schedule immediately, stops scheduling future phases but leaves the existing subscription in place.Input Parameters
Output
Update subscription
Update subscription
STRIPE_POST_V1_SUBSCRIPTIONS_LIST_SUBSCRIPTIONSUpdates 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.Input Parameters
Output
Update Tax Rate
Update Tax Rate
STRIPE_POST_V1_TAX_RATES_TAX_RATE2Tool to update an existing Stripe tax rate. Use when you need to modify tax rate properties such as display name, description, or active status.Input Parameters
Output
Create Meter Event Adjustment
Create Meter Event Adjustment
Present payment method on reader
Present payment method on reader
STRIPE_PRESENT_PAYMENT_METHODTool 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.Input Parameters
Output
Process setup intent on terminal reader
Process setup intent on terminal reader
STRIPE_PROCESS_SETUP_INTENTInitiates 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.Input Parameters
Output
Reactivate Billing Meter
Reactivate Billing Meter
Report Payment Attempt Failed
Report Payment Attempt Failed
Resume subscription
Resume subscription
STRIPE_RESUME_SUBSCRIPTIONResumes a paused Stripe subscription with billing cycle and proration options. Use when a customer wants to restart payment collection on a previously paused subscription.Input Parameters
Output
Retrieve Balance
Retrieve Balance
Retrieve Charge Details
Retrieve Charge Details
Retrieve Checkout Session
Retrieve Checkout Session
STRIPE_RETRIEVE_CHECKOUT_SESSIONTool to retrieve a Checkout Session object from Stripe. Use when you need to get the current state of a checkout session, including payment status, customer details, and line items.Input Parameters
Output
Retrieve customer
Retrieve customer
Retrieve payment intent
Retrieve payment intent
Retrieve Promotion Code
Retrieve Promotion Code
STRIPE_RETRIEVE_PROMOTION_CODETool to retrieve a Stripe promotion code by its ID. Use when you need to get details about a specific promotion code including its associated coupon, usage restrictions, and redemption statistics.Input Parameters
Output
Retrieve Upcoming Invoice
Retrieve Upcoming Invoice
STRIPE_RETRIEVE_UPCOMING_INVOICETool to preview the upcoming invoice for a customer, showing all pending charges including subscription renewals and invoice items. Use when you need to preview invoice amounts before they are finalized, test the effects of subscription updates including prorations, or estimate future billing.Input Parameters
Output
Search Stripe charges
Search Stripe charges
STRIPE_SEARCH_CHARGESSearch charges using Stripe’s Search Query Language. Use when you need to find historical charges by status, amount, customer, metadata, or other criteria.Input Parameters
next_page from a previous response for subsequent pages.Output
Search Stripe customers
Search Stripe customers
STRIPE_SEARCH_CUSTOMERSRetrieves a list of Stripe customers matching a search query that adheres to Stripe’s Search Query Language.Input Parameters
next_page value from a previous search response - NOT a numeric page number like ‘1’ or ‘2’. Omit this parameter on the first request. Only provide this when has_more is true in the previous response.Output
Search invoices
Search invoices
STRIPE_SEARCH_INVOICESSearches for invoices using Stripe’s Search Query Language. Use when you need to find invoices by status, total amount, customer, currency, or other criteria. Data is typically searchable within one minute, though propagation can lag up to an hour during outages.Input Parameters
next_page from a previous response for subsequent pages.created (timestamp), currency (3-letter ISO code), customer (customer ID), last_finalization_error_code (error code from finalization), last_finalization_error_type (error type from finalization), metadata (key-value pairs), number (invoice number), receipt_number (receipt number), status (draft/open/paid/uncollectible/void), subscription (subscription ID), total (amount in cents). Supports exact matches, range queries (>, <, >=, <=), boolean operators (AND, OR, NOT), and metadata search. Can combine up to 10 query clauses. Cannot mix AND with OR in the same query. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.Output
Search payment intents
Search payment intents
STRIPE_SEARCH_PAYMENT_INTENTSSearches for PaymentIntents using Stripe’s Search Query Language. Use when you need to find payments by status, amount, customer, or other criteria.Input Parameters
next_page from a previous response for subsequent pages.Output
Search Stripe prices
Search Stripe prices
STRIPE_SEARCH_PRICESSearch for prices using Stripe’s Search Query Language. Use when you need to find prices by status, currency, product, or other criteria with flexible query syntax.Input Parameters
next_page from a previous response for subsequent pages.Output
Search Stripe products
Search Stripe products
STRIPE_SEARCH_PRODUCTSTool to search for products using Stripe’s Search Query Language. Use when you need to find products based on specific criteria like active status, name, or metadata.Input Parameters
Output
Search subscriptions
Search subscriptions
STRIPE_SEARCH_SUBSCRIPTIONSSearches for subscriptions using Stripe’s Search Query Language. Use when you need to find subscriptions by status, metadata, created timestamp, or canceled_at timestamp.Input Parameters
next_page from a previous response for subsequent pages.Output
Send invoice for manual payment
Send invoice for manual payment
STRIPE_SEND_INVOICETool 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.Input Parameters
Output
Set reader display
Set reader display
Set terminal reader display
Set terminal reader display
STRIPE_SET_TERMINAL_READER_DISPLAYTool to set the display on a Stripe Terminal reader to show cart details. Use when you need to display line items, totals, and tax information on a physical terminal reader screen.Input Parameters
Output
Simulate successful input collection
Simulate successful input collection
STRIPE_SUCCEED_TEST_TERMINAL_READER_INPUT_COLLECTIONSimulates successful completion of an ongoing input collection on a Terminal reader. This test helper allows you to test your integration’s handling of successfully collected customer inputs (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.Input Parameters
Output
Simulate Terminal Reader Input Collection Timeout
Simulate Terminal Reader Input Collection Timeout
STRIPE_TIMEOUT_TEST_TERMINAL_READER_INPUT_COLLECTIONSimulate 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 flowsInput Parameters
Output
Update Application Fee Refund
Update Application Fee Refund
STRIPE_UPDATE_APPLICATION_FEE_REFUNDUpdates metadata on an existing application fee refund identified by its fee ID and refund ID.Input Parameters
Output
Update billing credit grant
Update billing credit grant
STRIPE_UPDATE_BILLING_CREDIT_GRANTUpdates an existing billing credit grant. Use when you need to modify the expiration time or metadata of a credit grant.Input Parameters
Output
Update Billing Meter
Update Billing Meter
STRIPE_UPDATE_BILLING_METERTool to update a billing meter’s display name. Use when you need to modify the name of an existing billing meter.Input Parameters
Output
Update Billing Portal Configuration
Update Billing Portal Configuration
Update Cash Balance Settings
Update Cash Balance Settings
STRIPE_UPDATE_CASH_BALANCETool 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.Input Parameters
Output
Update Charge
Update Charge
STRIPE_UPDATE_CHARGETool to update a Stripe charge object with provided parameters. Use when you need to modify charge details such as description, metadata, fraud assessment, receipt email, shipping information, or transfer group.Input Parameters
Output
Update Charge Dispute
Update Charge Dispute
STRIPE_UPDATE_CHARGE_DISPUTETool to update metadata on a charge’s dispute. Use when you need to attach structured information to a dispute for tracking or internal reference purposes.Input Parameters
Output
Update Charge Refund
Update Charge Refund
STRIPE_UPDATE_CHARGE_REFUNDTool to update a specified refund within a charge. Use when you need to modify the metadata of an existing refund.Input Parameters
Output
Update Checkout Session
Update Checkout Session
STRIPE_UPDATE_CHECKOUT_SESSIONTool to update a Stripe Checkout Session dynamically. Use when you need to modify customer information, line items, or shipping options on an existing checkout session. Line item updates require retransmitting the entire array.Input Parameters
Output
Update Coupon
Update Coupon
STRIPE_UPDATE_COUPONUpdates a Stripe coupon’s metadata, name, or currency options. Other coupon details (currency, duration, amount_off, percent_off) are, by design, not editable. Use when you need to modify coupon metadata, display name, or add new currency-specific discount amounts.Input Parameters
Output
Update Customer
Update Customer
STRIPE_UPDATE_CUSTOMERUpdates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged.Input Parameters
default_payment_method for newer integrations.Output
Update Customer Balance Transaction
Update Customer Balance Transaction
STRIPE_UPDATE_CUSTOMER_BALANCE_TXNUpdates 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.Input Parameters
Output
Update customer bank account
Update customer bank account
STRIPE_UPDATE_CUSTOMER_BANK_ACCOUNTUpdates a specified bank account for a given customer. Use when you need to modify account holder details or metadata for a customer’s bank account.Input Parameters
Output
Update customer bank account
Update customer bank account
STRIPE_UPDATE_CUSTOMER_BANK_ACCOUNT_SOURCEUpdates a bank account source attached to a customer. Use when you need to modify editable attributes like account holder name, type, or metadata.Input Parameters
Output
Update customer card
Update customer card
Update customer source
Update customer source
STRIPE_UPDATE_CUSTOMER_SOURCEUpdate a specified source for a given customer. Use when modifying card details, bank account information, or source metadata.Input Parameters
Output
Update Customer Subscription
Update Customer Subscription
STRIPE_UPDATE_CUSTOMER_SUBSCRIPTIONTool to update a subscription on a customer in Stripe. Use when modifying subscription items, billing settings, payment methods, or metadata. Requires both customer ID and subscription ID. Supports updating items, metadata, billing cycle, cancellation settings, and more.Input Parameters
Output
Update Dispute
Update Dispute
STRIPE_UPDATE_DISPUTETool to update a Stripe dispute by submitting evidence or updating metadata. Use when responding to payment disputes to provide documentation countering the dispute claim.Input Parameters
Output
Update entitlements feature
Update entitlements feature
STRIPE_UPDATE_ENTITLEMENT_FEATURETool to update a feature’s properties or deactivate it. Use when you need to modify an existing entitlements feature’s metadata, name, or active status.Input Parameters
Output
Update Event Destination
Update Event Destination
STRIPE_UPDATE_EVENT_DESTINATIONUpdates a v2 Event Destination with new values for specified parameters. Use when you need to modify an event destination’s name, description, enabled events, webhook URL, or metadata.Input Parameters
Output
Update External Account
Update External Account
STRIPE_UPDATE_EXTERNAL_ACCOUNTUpdates the metadata, account holder name, account holder type of an external bank account or card belonging to a connected account and optionally sets it as the default for its currency. Use when you need to modify external account details for a connected account, such as updating the account holder information or setting it as the default external account. Other bank account details are not editable by design. Requires the ‘account’ parameter (the Stripe account ID) and ‘id’ parameter (the external account ID). You can only update bank accounts when account.controller.requirement_collection is ‘application’, which includes Custom accounts.Input Parameters
Output
Update Invoice
Update Invoice
Update invoice item
Update invoice item
STRIPE_UPDATE_INVOICEITEMUpdates an invoice item on a draft invoice. Use when modifying invoice item properties like amount, description, discounts, or tax settings before invoice finalization.Input Parameters
Output
Bulk update invoice line items
Bulk update invoice line items
STRIPE_UPDATE_INVOICE_LINESBulk updates existing line items on a draft invoice, including descriptions, amounts, quantities and discounts. It can also update metadata on the invoice itself.Input Parameters
Output
Update Payment Intent
Update Payment Intent
STRIPE_UPDATE_PAYMENT_INTENTUpdates a Stripe PaymentIntent with new values for specified parameters; note that if currency is updated, amount might also be required, and certain updates (e.g., to payment_method) can necessitate re-confirmation by the customer.Input Parameters
name, phone, and an address object with line1, line2 (optional), city, state, postal_code, and country.statement_descriptor (max 22 characters).Output
Update Payment Link
Update Payment Link
Update Payment Method
Update Payment Method
STRIPE_UPDATE_PAYMENT_METHODUpdates an existing PaymentMethod object in Stripe. Use when you need to modify billing details, expiration dates, or metadata for a payment method. The payment method must be attached to a customer before updates can be applied.Input Parameters
Output
Update a price
Update a price
STRIPE_UPDATE_PRICEUpdates a Stripe price by setting passed parameter values; unspecified parameters remain unchanged. Use when you need to modify price metadata, active status, lookup key, or nickname. Note: Price amounts cannot be modified via API.Input Parameters
Output
Update product
Update product
STRIPE_UPDATE_PRODUCTTool to update an existing product in Stripe. Use when you need to modify product details like name, description, pricing, or availability.Input Parameters
Output
Update Promotion Code
Update Promotion Code
STRIPE_UPDATE_PROMOTION_CODEUpdates an existing Stripe promotion code by setting the values of the parameters passed. Use when you need to activate/deactivate a promotion code, update its metadata, or modify redemption restrictions. Most promotion code fields are intentionally non-editable after creation.Input Parameters
Output
Update Quote
Update Quote
STRIPE_UPDATE_QUOTETool to update an existing Stripe quote with new values. Use when modifying quote details like description, line items, metadata, or other quote parameters.Input Parameters
Output
Update Source
Update Source
STRIPE_UPDATE_SOURCEUpdates 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.Input Parameters
Output
Update Subscription
Update Subscription
STRIPE_UPDATE_SUBSCRIPTIONUpdates an existing, non-canceled Stripe subscription by its ID, including supported item, billing, payment, tax, cancellation, and metadata settings.Input Parameters
liability may be required if enabled is true.Output
Update Subscription Schedule
Update Subscription Schedule
STRIPE_UPDATE_SUBSCRIPTION_SCHEDULETool to update an existing subscription schedule in Stripe. Use when you need to modify phases, default settings, metadata, or end behavior of a subscription schedule.Input Parameters
Output
Update Tax Registration
Update Tax Registration
STRIPE_UPDATE_TAX_REGISTRATIONTool to update an existing tax registration in Stripe. Use when you need to modify the active_from or expires_at fields of a registration. Registrations cannot be deleted after creation; use expires_at to terminate them instead.Input Parameters
Output
Update Tax Settings
Update Tax Settings
Update Terminal Location
Update Terminal Location
STRIPE_UPDATE_TERMINAL_LOCATIONUpdates a Terminal Location by modifying specified parameters. Use when you need to change location details like display name, address, phone, or metadata.Input Parameters
Output
Update Terminal Reader
Update Terminal Reader
STRIPE_UPDATE_TERMINAL_READERTool to update a Terminal Reader object by setting parameter values. Use when you need to modify the label or metadata of an existing reader device.Input Parameters
Output
Validate payment method domain
Validate payment method domain
STRIPE_VALIDATE_PAYMENT_METHOD_DOMAINTool to validate an existing payment method domain in Stripe to activate payment methods. Use when additional registration steps need to be completed before a payment method can be used in Elements or Embedded Checkout.Input Parameters
Output
Verify microdeposits on setup intent
Verify microdeposits on setup intent
STRIPE_VERIFY_MICRODEPOSITSVerifies 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.Input Parameters
Output
Verify microdeposits on payment intent
Verify microdeposits on payment intent
STRIPE_VERIFY_MICRODEPOSITS_PAYMENT_INTENTVerifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code. Use after microdeposits are sent to complete bank account verification.Input Parameters
Output
Void a credit note
Void a credit note
Void an invoice
Void an invoice
STRIPE_VOID_INVOICEVoids a finalized Stripe invoice while maintaining a paper trail. Voiding is permanent and cannot be undone; draft invoices should be deleted instead.Input Parameters
Output
Who Am I
Who Am I
Triggers
Charge Captured
Charge Captured
Charge Dispute Closed
Charge Dispute Closed
Charge Dispute Created
Charge Dispute Created
Charge Dispute Updated
Charge Dispute Updated
Charge Failed
Charge Failed
Charge Refunded
Charge Refunded
Charge Refund Updated
Charge Refund Updated
Charge Succeeded
Charge Succeeded
Checkout Session Async Payment Failed
Checkout Session Async Payment Failed
Checkout Session Async Payment Succeeded
Checkout Session Async Payment Succeeded
Checkout Session Completed
Checkout Session Completed
Checkout Session Expired
Checkout Session Expired
Customer Created
Customer Created
Customer Deleted
Customer Deleted
Customer Subscription Created
Customer Subscription Created
Customer Subscription Deleted
Customer Subscription Deleted
Customer Subscription Trial Will End
Customer Subscription Trial Will End
STRIPE_CUSTOMER_SUBSCRIPTION_TRIAL_WILL_ENDType: webhookOccurs three days before a subscription’s trial period is scheduled to end, or immediately when a trial is ended early (for example, with trial_end=now or when a Customer Portal plan change ends a trial). If a trial is shortened so that fewer than three days remain, this event can fire immediately, including during the same transaction that collects payment. Before sending payment-reminder communications from this webhook, check the subscription status and latest invoice to determine whether payment has already been collected.Payload
Customer Subscription Updated
Customer Subscription Updated
Customer Updated
Customer Updated
Invoice Created
Invoice Created
STRIPE_INVOICE_CREATEDType: webhookOccurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see Using Webhooks with Subscriptions.Payload
Invoice Finalized
Invoice Finalized
Invoiceitem Created
Invoiceitem Created
Invoice Paid
Invoice Paid
Invoice Payment Failed
Invoice Payment Failed
STRIPE_INVOICE_PAYMENT_FAILEDType: webhookOccurs whenever an invoice payment attempt fails, due to either a declined payment, including soft decline, or to the lack of a stored payment method.Payload
Invoice Payment Succeeded
Invoice Payment Succeeded
Invoice Upcoming
Invoice Upcoming
STRIPE_INVOICE_UPCOMINGType: webhookOccurs X number of days before a subscription is scheduled to create an invoice that is automatically charged-where X is determined by your subscriptions settings. Note: The received Invoice object will not have an invoice ID.Payload
Invoice Voided
Invoice Voided
Payment Intent Canceled
Payment Intent Canceled
Payment Intent Created
Payment Intent Created
Payment Intent Payment Failed
Payment Intent Payment Failed
Payment Intent Requires Action
Payment Intent Requires Action
Payment Intent Succeeded
Payment Intent Succeeded
Payment Link Created
Payment Link Created
Payout Failed
Payout Failed
Payout Paid
Payout Paid
STRIPE_PAYOUT_PAIDType: webhookOccurs whenever a payout is expected to be available in the destination account. If the payout fails, a payout.failed notification is also sent, at a later time.Payload
Price Created
Price Created
Price Updated
Price Updated
Product Created
Product Created
Product Updated
Product Updated