Stripe

Tool to accept a quote in Stripe. Use when you need to accept a finalized quote, which will create an invoice, subscription, or subscription schedule based on the quote's configuration.

Reactivates a billing alert, allowing it to trigger again. Use when you need to resume monitoring usage thresholds and receiving notifications for a previously deactivated alert.

Tool to add multiple line items to a draft Stripe invoice. Use when you need to add additional charges, services, or credits to an existing invoice that is still in draft status.

Advance a test clock to a future timestamp. Use for testing time-based billing scenarios. Requires test mode API keys (test_helpers endpoints are only available in test mode). The advancement is asynchronous; monitor the status field to track completion (status changes from 'advancing' to 'ready').

Manually reconciles remaining amount for a customer_balance PaymentIntent by applying funds from customer's cash balance. IMPORTANT: This action only works with PaymentIntents that have 'customer_balance' in their payment_method_types. The customer_balance payment method type must be enabled in your Stripe account settings. Use this when you need to apply funds from a customer's cash balance account to complete or partially fund a PaymentIntent.

Tool to archive a billing alert in Stripe, removing it from list views and APIs. Use when you need to permanently archive a billing alert. This action is non-reversible.

Attach a payment source (card token or source object) to a customer for future charges. IMPORTANT: This is a legacy API. For new integrations, use the PaymentMethods API instead (STRIPE_ATTACH_PAYMENT_METHOD). The source parameter accepts: - Card tokens (tok_xxxx) created client-side via Stripe.js or mobile SDKs - Source objects (src_xxxx) for alternative payment methods NOTE: PaymentMethod objects (pm_xxxx) cannot be used with this endpoint. Use STRIPE_ATTACH_PAYMENT_METHOD for those. In test mode, you can use test tokens like 'tok_visa'. In live mode, tokens must be created client-side for PCI compliance.

Attaches a PaymentIntent or Out of Band Payment to an invoice's payments list. When the PaymentIntent status changes to succeeded, the payment is credited to the invoice. Use when you need to associate an existing payment with a specific invoice.

Attaches a PaymentMethod to a Customer. Use when you need to save a payment method for future use with a specific customer. The PaymentMethod must be in a detached state before attaching.

Tool to attach a feature to a product. Use when you need to add a feature to a product's capabilities. This creates a product_feature object linking the feature to the product.

Cancels a PaymentIntent when in cancelable state. Use when a PaymentIntent is no longer needed to prevent further charges. For PaymentIntents with status='requires_capture', the remaining amount_capturable will be automatically refunded.

Tool to cancel a Stripe quote. Use when you need to cancel an existing quote that is in 'draft' or 'open' status. Once canceled, the quote cannot be finalized or accepted by the customer.

Cancels a SetupIntent that is no longer needed. Use when a SetupIntent is in 'requires_payment_method', 'requires_confirmation', or 'requires_action' state. Note: SetupIntents linked to Checkout Sessions cannot be canceled through this method.

Cancels a customer's active Stripe subscription at the end of the current billing period, with options to invoice immediately for metered usage and prorate charges for unused time.

Cancels a subscription schedule and its associated subscription immediately (if active). Use when you need to stop scheduling of phases while leaving any existing subscription in place. Only succeeds if the schedule status is 'not_started' or 'active'.

Tool to cancel the current reader action. Use when you need to halt any ongoing operation on a Stripe Terminal reader device such as payment collection, setup intent processing, or input collection.

Tool to capture payment on an uncaptured charge. Use when a charge was created with capture=false and you're ready to capture the payment.

Captures the funds of an existing uncaptured PaymentIntent. Use when the PaymentIntent status is 'requires_capture'.

Tool to close a dispute. Use when you want to dismiss a dispute and acknowledge it as lost, indicating no evidence will be submitted. This action is irreversible.

Initiates input collection on a Terminal Reader to display forms and collect customer information. Use when you need to gather email, phone, text, numeric, signature, or selection inputs from customers on a physical reader.

Tool to initiate payment method collection on a Stripe Terminal Reader. Use when you need to hand off a PaymentIntent to a physical card reader device to collect payment details. The Reader action executes asynchronously with action.status showing 'in_progress' initially.

Tool to confirm customer intent to pay with current or provided payment method. Use when ready to finalize a PaymentIntent and initiate the payment attempt. A return_url is required if confirmation needs customer action like 3D Secure authentication.

Confirms a SetupIntent to complete customer payment method setup. Use when you need to finalize credential collection after creating a SetupIntent.

Tool to confirm a PaymentIntent on a Terminal reader device. Use when you need to finalize a payment transaction on a card reader after the PaymentIntent has been collected on the reader hardware.

Tool to create or update card payments capability for a Stripe Connect account. Use when you need to enable or disable card payment processing for a connected account.

Creates 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.

Tool to create an Apple Pay domain registration. Use when registering your domain with Apple Pay to accept Apple Pay payments on your website. Stripe handles the Apple merchant validation process.

Tool to create a secret in the Stripe Secret Store. Use when you need to securely persist secrets for use by UI Extensions and app backends.

Tool to create a single-use token representing bank account details. Use when you need to securely collect bank account information for ACH payments, direct debits, or adding a bank account to a customer or recipient.

Tool to create a billing alert that monitors usage on a billing meter and triggers notifications when a specified threshold is crossed. Use when you need to set up usage-based billing alerts.

Tool to create a credit grant that allocates billing credits to a customer for use against metered pricing. Use when you need to provide promotional or paid credits to customers.

Tool to create a billing meter in Stripe for tracking usage events. Use when you need to set up a new meter to track API calls, storage usage, or other measurable customer actions that form the basis of billing calculations.

Creates a billing meter event using Stripe API v2 for usage-based billing. Use when recording customer usage that will be metered and billed according to configured billing meters.

Creates an adjustment to cancel a billing meter event. Use when you need to correct errors or remove events attached to the wrong customer within 24 hours of Stripe receiving them.

Creates authentication session for high-throughput meter event stream. Use when you need to send meter events to Stripe's billing system; tokens are valid for 15 minutes.

Tool to create a Stripe billing portal configuration. Use when you need to define the functionality and behavior of a customer portal session, including which features customers can access.

Tool to create a Stripe billing portal session. Use when you need to provide customers with a secure URL to manage their subscriptions, payment methods, and invoices.

Tool to create a charge to request payment from a credit or debit card. Use when you need to charge a payment source directly. Note: This method is deprecated; Stripe recommends using the Payment Intents API instead for new integrations.

Tool to create a refund for a charge in Stripe. Use when you need to refund a previously created charge fully or partially.

Tool to create a Stripe Checkout Session. Use when you need a secure, hosted URL to collect payments or subscriptions via Stripe Checkout.

Creates a new discount coupon in Stripe with percentage or fixed amount discount. Use when creating promotional discounts for customers.

Issues a credit note to adjust a finalized invoice's amount. Use when you need to credit an invoice after finalization, either for refunds, customer balance credits, or out-of-band adjustments.

Creates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications.

Tool to create an immutable transaction that updates the customer's credit balance. Use when you need to manually adjust a customer's balance, such as issuing credits or debits.

Tool to create a new bank account attached to a customer object. Use when you need to add a bank account as a payment source for an existing Stripe customer.

Creates 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.

Tool to create a Stripe Customer Session granting client-side access control over a Customer. Use when you need to provide temporary access to customer portal features.

Attaches a payment source to a customer for later reuse. Use when you need to save a card, bank account, or other payment source for future charges.

Tool to create a subscription for an existing customer. Use when creating a new subscription with items and prices for a specific customer.

Creates a new tax ID for a customer, used for tax compliance and invoicing across 100+ supported country-specific tax ID formats. Use when you need to add tax identification to a customer account.

Creates a single-use token representing an updated CVC value for card payments. Use when you need to update the CVC for an existing card without collecting the full card details again.

Creates a new feature entitlement in Stripe representing a monetizable ability or functionality. Use when defining features that can be assigned to products and customers.

Tool to create a short-lived ephemeral API key for secure mobile SDK access to specific Stripe resources. Use when integrating with Stripe iOS, Android SDKs, or Stripe.js for Issuing Cards.

Tool to upload a file to Stripe for business purposes such as dispute evidence, identity verification, or business logos. Use when you need to store files that can be attached to other Stripe objects.

Tool to create a file link object that generates a shareable URL for accessing uploaded files. Use when you need to provide temporary or permanent access to a Stripe file.

Tool to create a Financial Connections Session to launch the authorization flow for linking financial accounts. Use when you need to collect customer bank account information for payments or data access.

Tool to create an FX quote for currency conversion with optional rate locking. Use when you need to view current exchange rates for currency pairs or extend quoted rates for 5 minutes to 24 hours to reduce FX fluctuation uncertainty.

Creates a new draft Stripe invoice for a customer; use to revise an existing invoice, bill for a specific subscription (which must belong to the customer), or apply detailed customizations. Note: Stripe API enforces a maximum value of 99,999,999 (in smallest currency unit) for amount fields including `unit_amount` in invoice items, `application_fee_amount`, and `transfer_data.amount`. Values exceeding this limit will be rejected.

Tool to create an invoice item for draft invoices. Use when adding line items to customer invoices before finalization.

Creates a Stripe PaymentIntent to initiate and process a customer's payment; using `application_fee_amount` for a connected account requires the `Stripe-Account` header.