Payments and business tools
Stripe provides 26 tools that can be used to interact with its services.
cancel_subscriptionThis tool will cancel a subscription in Stripe.
It takes the following arguments:
subscriptionstringThe ID of the subscription to cancel.
create_couponThis tool will create a coupon in Stripe.
It takes several arguments:
Only use one of percent_off or amount_off, not both:
Optional arguments for duration. Use if specific duration is desired, otherwise default to 'once'.
namestringName of the coupon displayed to customers on invoices or receipts
amount_offnumberA positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed)
currencystringThree-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed). Infer based on the amount_off. For example, if a coupon is $2 off, set currency to be USD.
USDdurationstringHow long the discount will last. Defaults to "once"
foreveroncerepeatingonceduration_in_monthsnumberThe number of months the discount will last if duration is repeating
percent_offnumberA positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed)
create_customerThis tool will create a customer in Stripe.
It takes two arguments:
namestringThe name of the customer
emailstringThe email of the customer
create_invoiceThis tool will create an invoice in Stripe.
It takes two arguments:
customerstringThe ID of the customer to create the invoice for.
days_until_duenumberThe number of days until the invoice is due.
create_invoice_itemThis tool will create an invoice item in Stripe.
It takes three arguments:
customerstringThe ID of the customer to create the invoice item for.
invoicestringThe ID of the invoice to create the item for.
pricestringThe ID of the price for the item.
create_payment_linkThis tool will create a payment link in Stripe.
It takes two arguments:
pricestringThe ID of the price to create the payment link for.
quantitynumberThe quantity of the product to include.
create_priceThis tool will create a price in Stripe. If a product has not already been specified, a product should be created first.
It takes three arguments:
currencystringThe currency of the price.
productstringThe ID of the product to create the price for.
unit_amountnumberThe unit amount of the price in cents.
recurringobjectThe recurring components of a price such as its interval.
create_productThis tool will create a product in Stripe.
It takes two arguments:
namestringThe name of the product.
descriptionstringThe description of the product.
create_refundThis tool will refund a payment intent in Stripe.
It takes three arguments:
payment_intentstringThe ID of the PaymentIntent to refund.
amountintegerThe amount to refund in cents.
reasonstringThe reason for the refund.
duplicatefraudulentrequested_by_customerfetchRetrieve Stripe object details by ID.
This tool fetches the object information from Stripe including all available fields. Use this after finding the Stripe object ID(s) with the search tool to get complete information for analysis.
It takes one argument:
idstringThe unique identifier for the Stripe object (e.g. cus_123, pi_123).
finalize_invoiceThis tool will finalize an invoice in Stripe.
It takes one argument:
invoicestringThe ID of the invoice to finalize.
get_stripe_account_infoThis will get the account info for the logged in Stripe account.
list_couponsThis tool will fetch a list of Coupons from Stripe.
It takes one optional argument:
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100.
list_customersThis tool will fetch a list of Customers from Stripe.
It takes two arguments:
emailstringA case-sensitive filter on the list based on the customer's email field. The value must be a string.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100.
list_disputesThis tool will fetch a list of disputes in Stripe.
It takes the following arguments:
chargestringOnly return disputes associated to the charge specified by this charge ID.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
10payment_intentstringOnly return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
list_invoicesThis tool will fetch a list of Invoices from Stripe.
It takes two arguments:
customerstringThe ID of the customer to list invoices for.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
list_payment_intentsThis tool will list payment intents in Stripe.
It takes two arguments:
Note that the payment intent amount returned is in currency minor units, e.g. cents for USD and yen for JPY.
customerstringThe ID of the customer to list payment intents for.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100.
list_pricesThis tool will fetch a list of Prices from Stripe.
It takes two arguments.
Note that the price unit_amount returned is in currency minor units, e.g. cents for USD and yen for JPY.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
productstringThe ID of the product to list prices for.
list_productsThis tool will fetch a list of Products from Stripe.
It takes one optional argument:
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
list_subscriptionsThis tool will list all subscriptions in Stripe.
It takes four arguments:
customerstringThe ID of the customer to list subscriptions for.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100.
pricestringThe ID of the price to list subscriptions for.
statusstringThe status of the subscriptions to retrieve.
activeallcanceledincompleteincomplete_expiredpast_duetrialingunpaidretrieve_balanceThis tool will retrieve the balance from Stripe. It takes no input.
searchThis tool can be used to search for specific Stripe resources using a custom Stripe query syntax. It is only able to search for the following resources: customers, payment_intents, charges, invoices, prices, products, subscriptions. It returns a maximum of 100 results.
It takes one argument:
querystringThis query string should be formatted as 'resource:query_clause', where 'resource' is one of (customers, payment_intents, charges, invoices, prices, products, subscriptions), and 'query_clause' is the actual query in Stripe's custom query syntax to query metadata for that resource. For example, for the query: customers:email:"jenny.rosen@example.com" resource: `customers` query_clause: `email:"jenny.rosen@example.com"` A query clause consists of a field, operator, and value. ## Query Fields for customers * created * email * metadata * name * phone ## Query Fields for payment_intents * amount * created * currency * customer * metadata * status ## Query Fields for charges * amount * billing_details.address.postal_code * created * currency * customer * disputed * metadata * payment_method_details.{{SOURCE}}.last4 * payment_method_details.{{SOURCE}}.exp_month * payment_method_details.{{SOURCE}}.exp_year * payment_method_details.{{SOURCE}}.brand * payment_method_details.{{SOURCE}}.fingerprint * refunded * status ## Query Fields for invoices * created * currency * customer * last_finalization_error_code * last_finalization_error_type * metadata * number * receipt_number * status * subscription * total ## Query Fields for prices * active * currency * lookup_key * metadata * product * type ## Query Fields for products * active * description * metadata * name * shippable * url ## Query Fields for subscriptions * created * metadata * status * canceled_at ## Search Operators The following table lists the syntax that you can use to construct a query: | Syntax | Usage | Description | When to Use | Examples | |--------|-------|-------------|-------------|----------| | `:` | `field:value` | Exact match operator (case insensitive) | **ONLY when you know the exact complete value** | `currency:"eur"` returns records where the currency is exactly "EUR" | | `~` | `field~value` | Substring match operator (minimum 3 characters) | **ALWAYS use for domain searches, partial names, email parts** | `email~"foo.com"` returns emails containing "foo.com" | | `AND`, `and` | `field:value1 AND field:value2` | Returns records that match both clauses | Combining multiple conditions | `status:"active" AND amount:500` | | `OR`, `or` | `field:value1 OR field:value2` | Returns records that match either clause | Alternative conditions | `currency:"usd" OR currency:"eur"` | | `-` | `-field:value` | Returns records that don't match the clause | Excluding specific values | `-currency:"jpy"` returns records not in JPY | | `NULL`, `null` | `field:null` | Checks for field presence (empty/null values) | Finding empty fields | `url:null` returns records where URL field is empty | | `>`, `<`, `>=`, `<=`, `=` | `field>value`, `field<value`, etc. | Numeric comparison operators | Amount ranges, dates | `amount>="10"` returns records with amount >= 10 | | `` | `" """` | Escape quotes within quotes | When quotes are in the search value | `description:"the story called "The Sky and the Sea.""` | ## Query Rules * You can combine up to 10 query clauses in a search by separating them with a space or using AND/OR keywords (case insensitive) * You cannot combine AND and OR in the same query * No parentheses are supported for operator precedence * By default, the API combines clauses with AND logic * You must use quotation marks around string values (optional for numeric values) * You can escape quotes inside quotes with a backslash (\) ## Examples Input: Look up charges matching a custom metadata value. Output: charges:metadata['order_id']:'1234567890' Input: Look up charges matching the last 4 digits of the card used for the payment. Output: charges:payment_method_details.card.last4:4242 Input: Look up customers matching an email. Output: customers:email:'jenny.rosen@example.com' Input: Look up PaymentIntents not in the USD currency. Output: payment_intents:-currency:'usd' Input: Filter invoice objects with a total greater than 1000. Output: invoices:total>1000 Input: Filter payments with a amount over $100. Reasoning: Stripe "amount" field is in cents, so we use 1000 instead of 100 Output: payment_intents:amount>1000 Input: Look up charges matching a combination of metadata and currency. Output: charges:metadata['key']:'value' AND currency:'usd' Input: Search for customers with email containing "john". Output: customers:email~"john" Input: Find products where the description field is empty. Output: products:description:null Input: Search for payments with amounts greater than or equal to 5000. Output: payment_intents:amount>=5000 Input: Search for products with description with escaped quotes. Output: products:description:"The story called "The Sky and the Sea"."
search_stripe_documentationSearch the Stripe documentation for the given question and language.
It takes two arguments:
questionstringThe user question about integrating with Stripe will be used to search the documentation.
languagestringThe programming language to search for in the the documentation.
dotnetgojavanodephprubypythoncurlsearch_only_api_refbooleanWhen set to true, search only in the Stripe API reference documentation instead of the full documentation set. Use true when users need specific API implementation details, code examples, or parameter references. Use false (default) for conceptual explanations, best practices, integration guides, or troubleshooting help.
stripe_integration_recommenderGuides users through Stripe integration planning via interactive Q&A. Analyzes payment requirements and recommends the appropriate Stripe products (Checkout, Elements, Billing, Connect, etc.) with step-by-step implementation guidance.
WHEN TO USE: Call this tool when the user expresses:
IMPORTANT BEHAVIOR:
PARAMETERS:
Technical context you've observed (e.g., "Python/Flask backend", "user wants minimal code to go live quickly", "already has Stripe SDK installed").
Returns JSON:
question to present to user and plan_id to include in next call.WORKFLOW:
LIMITATIONS:
answerstringFor new plans (no plan_id): 2-3 sentence summary including (1) business name and payment model, (2) tech stack with frontend AND backend (use 'UNKNOWN' for unknown components), (3) payment requirements (use 'UNKNOWN' if not specified). For existing plans: User's verbatim response. Accepts option selections ('Option 1'), natural language, clarifying questions, or 'UNKNOWN'.
notesstringOptional agent-discovered context from codebase analysis (e.g., 'Found Stripe SDK v12.0.0', 'Existing webhook at /api/stripe'). Helps backend provide accurate recommendations.
plan_idstringPlan identifier in format lplan_[alphanumeric] from previous response. Required for continuing existing plan. Omit when starting new plan.
update_disputeWhen you receive a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help resolve the dispute in your favor. This tool helps.
It takes the following arguments:
disputestringThe ID of the dispute to update
evidenceobjectEvidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review.
submitbooleanWhether to immediately submit evidence to the bank. If false, evidence is staged on the dispute.
update_subscriptionThis tool will update an existing subscription in Stripe. If changing an existing subscription item, the existing subscription item has to be set to deleted and the new one has to be added.
It takes the following arguments:
subscriptionstringThe ID of the subscription to update.
itemsarrayA list of subscription items to update, add, or remove.
proration_behaviorstringDetermines how to handle prorations when the subscription items change.
always_invoicecreate_prorationsnonenone_implicit