Stripe

Learn how to use Stripe with Composio

Overview

SLUG: STRIPE

Description

Stripe offers online payment infrastructure, fraud prevention, and APIs enabling businesses to accept and manage payments globally

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read_write
generic_api_key
stringRequired

Connecting to Stripe

Create an auth config

Use the dashboard to create an auth config for the Stripe toolkit. This allows you to connect multiple Stripe accounts to Composio for agents to use.

1

Select App

Navigate to Stripe.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Stripe Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4stripe_auth_config_id = "ac_YOUR_STRIPE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Stripe: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, stripe_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4stripe_auth_config_id = "ac_YOUR_STRIPE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Stripe for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, stripe_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Stripe toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Accept quote

Description

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.

Action Parameters

quote_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add lines to invoice

Description

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.

Action Parameters

id
stringRequired
invoice_metadata
lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Apply customer balance to payment intent

Description

Manually reconciles remaining amount for customer_balance PaymentIntent by applying funds from customer's cash balance. Use when you need to apply a customer's cash balance to a PaymentIntent that uses the customer_balance payment method type.

Action Parameters

amount
currency
intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Apply customer balance to payment intent

Description

Tool to manually reconcile customer balance on a PaymentIntent using cash balance funds. Use when you need to apply funds from a customer's cash balance account to a customer_balance PaymentIntent.

Action Parameters

amount
currency
payment_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach payment method to customer

Description

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.

Action Parameters

customer
customer_account
payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel payment intent

Description

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.

Action Parameters

cancellation_reason
payment_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Quote

Description

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.

Action Parameters

quote_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel setup intent

Description

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.

Action Parameters

cancellation_reason
setup_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel subscription

Description

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.

Action Parameters

cancellation_details
invoice_now
boolean
prorate
boolean
subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Capture Charge

Description

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.

Action Parameters

amount
application_fee_amount
charge
stringRequired
receipt_email
statement_descriptor
statement_descriptor_suffix
transfer_data_amount
transfer_group

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Capture payment intent

Description

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

Action Parameters

amount_to_capture
application_fee_amount
final_capture
intent
stringRequired
metadata
statement_descriptor
statement_descriptor_suffix

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm payment intent

Description

Confirms a Stripe PaymentIntent to finalize a payment; a `return_url` is necessary if the payment method requires customer redirection.

Action Parameters

capture_method
string
payment_intent_id
stringRequired
payment_method
string
receipt_email
string
return_url
string
setup_future_usage
string
shipping
object

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm setup intent

Description

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

Action Parameters

confirmation_token
payment_method
return_url
setup_intent_id
stringRequired
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Billing Portal Session

Description

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.

Action Parameters

configuration
customer
customer_account
flow_data
locale
on_behalf_of
return_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Card

Description

Tool to create a new card as a payment source for an existing customer. Use when you need to add a credit or debit card to a customer's account.

Action Parameters

customer_id
stringRequired
metadata
source
Required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Checkout Session

Description

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

Action Parameters

allow_promotion_codes
cancel_url
client_reference_id
customer
line_items
arrayRequired
metadata
mode
stringRequired
payment_method_types
success_url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Coupon

Description

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

Action Parameters

amount_off
applies_to
currency
currency_options
duration
stringDefaults to once
duration_in_months
id
max_redemptions
metadata
name
percent_off
redeem_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Credit Note

Description

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.

Action Parameters

amount
credit_amount
effective_at
email_type
invoice
stringRequired
lines
memo
metadata
out_of_band_amount
reason
refund_amount
refunds
shipping_cost

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer

Description

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

Action Parameters

address
description
email
name
phone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer Balance Transaction

Description

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.

Action Parameters

amount
integerRequired
currency
stringRequired
customer
stringRequired
description
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer Session

Description

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.

Action Parameters

components
objectRequired
customer
customer_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer Tax ID

Description

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.

Action Parameters

customer
stringRequired
type
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create CVC Update Token

Description

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.

Action Parameters

cvc
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Ephemeral Key

Description

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.

Action Parameters

customer
expand
issuing_card
nonce
stripe_version
stringRequired
verification_session

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create File

Description

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.

Action Parameters

file
objectRequired
file_link_data
purpose
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create an invoice

Description

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.

Action Parameters

account_tax_ids
application_fee_amount
auto_advance
automatic_tax
automatically_finalizes_at
collection_method
currency
custom_fields
customer
stringRequired
days_until_due
default_payment_method
default_source
default_tax_rates
description
discounts
due_date
footer
from_invoice
issuer
metadata
number
on_behalf_of
payment_settings
pending_invoice_items_behavior
rendering
shipping_cost
shipping_details
statement_descriptor
subscription
transfer_data

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create payment intent

Description

Tool to create a PaymentIntent for collecting payment from customers. Use when initiating a new payment flow with support for 50+ payment methods including cards, digital wallets, and bank transfers.

Action Parameters

amount
integerRequired
application_fee_amount
automatic_payment_methods
capture_method
confirm
confirmation_method
currency
stringRequired
customer
description
error_on_requires_action
mandate
metadata
off_session
on_behalf_of
payment_method
payment_method_options
payment_method_types
receipt_email
return_url
setup_future_usage
shipping
statement_descriptor
statement_descriptor_suffix
transfer_data
transfer_group

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create payment method

Description

Creates a PaymentMethod object for collecting payments or storing payment details. Use when you need to create a new payment method that can be attached to customers or used with PaymentIntents. The type parameter determines which payment-specific fields are required (e.g., card requires card details, sepa_debit requires IBAN).

Action Parameters

acss_debit
allow_redisplay
au_becs_debit
bacs_debit
billing_details
boleto
card
klarna
metadata
radar_options
sepa_debit
type
stringRequired
us_bank_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create payment method domain

Description

Tool to create a payment method domain object to control where payment methods are shown. Use when registering a new web domain with Stripe to enable payment processing capabilities.

Action Parameters

domain_name
stringRequired
enabled

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Preview Invoice

Description

Tool to preview an upcoming invoice without creating it. Use when you need to show pending charges, renewal fees, discounts, and prorations before finalizing an invoice.

Action Parameters

automatic_tax
currency
customer
customer_account
customer_details
discounts
invoice_items
issuer
on_behalf_of
preview_mode
schedule
subscription
subscription_details

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a price

Description

Creates a new Stripe Price for a product, defining its charges (one-time or recurring) and billing scheme; requires either an existing `product` ID or `product_data`.

Action Parameters

active
booleanDefaults to True
billing_scheme
currency
stringRequired
currency_options
custom_unit_amount
lookup_key
metadata
nickname
product
product_data
recurring
tax_behavior
tiers
tiers_mode
transfer_lookup_key
transform_quantity
unit_amount
unit_amount_decimal

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create product

Description

Creates a new product in Stripe, encoding the request as `application/x-www-form-urlencoded` by flattening nested structures.

Action Parameters

active
booleanDefaults to True
custom_fields
default_price_data
description
id
images
marketing_features
metadata
name
stringRequired
package_dimensions
shippable
shipping_cost
statement_descriptor
tax_code
unit_label
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Promotion Code

Description

Tool to create a promotion code linked to an underlying coupon. Use when you need to generate customer-redeemable codes with optional restrictions.

Action Parameters

active
code
coupon
stringRequired
customer
expires_at
max_redemptions
metadata
restrictions

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a quote

Description

Tool to create a Stripe quote modeling prices and services for a customer. Use when you need to generate a formal quote for a customer before finalizing payment.

Action Parameters

application_fee_amount
application_fee_percent
automatic_tax
collection_method
customer
customer_account
default_tax_rates
description
discounts
expires_at
footer
from_quote
header
invoice_settings
line_items
metadata
on_behalf_of
subscription_data
test_clock
transfer_data

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Refund

Description

Creates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID.

Action Parameters

amount
charge
metadata
payment_intent
reason
refund_application_fee
reverse_transfer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a Report Run

Description

Creates a new report run object and begins executing the report asynchronously. Use when you need to generate Stripe reports such as balance summaries or itemized transaction reports.

Action Parameters

parameters
report_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create setup intent

Description

Creates a SetupIntent to collect payment method authorization for future charges. Use when setting up payment methods for subscriptions or saving cards for later use.

Action Parameters

attach_to_self
automatic_payment_methods
confirm
confirmation_token
customer
description
flow_directions
mandate_data
metadata
on_behalf_of
payment_method
payment_method_options
payment_method_types
return_url
single_use
usage
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a shipping rate

Description

Creates a new shipping rate object that appears on Checkout Sessions for customer display. Use when defining shipping costs for products.

Action Parameters

delivery_estimate
display_name
stringRequired
fixed_amount
objectRequired
metadata
tax_behavior
tax_code
type
Defaults to fixed_amount

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Source

Description

Tool to create a Stripe source object for accepting payment methods. Use when you need to process payments through various payment methods like cards, bank transfers, or redirect-based payment systems.

Action Parameters

amount
currency
flow
mandate
metadata
owner
receiver
redirect
source_order
statement_descriptor
token
type
usage

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create subscription

Description

Creates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options.

Action Parameters

add_invoice_items
application_fee_percent
automatic_tax
backdate_start_date
billing_cycle_anchor
billing_cycle_anchor_config
billing_thresholds
cancel_at
cancel_at_period_end
boolean
collection_method
stringDefaults to charge_automatically
currency
customer
stringRequired
days_until_due
default_payment_method
default_source
default_tax_rates
description
discounts
invoice_settings
items
arrayRequired
metadata
off_session
on_behalf_of
payment_behavior
payment_settings
pending_invoice_item_interval
promotion_code
proration_behavior
transfer_data
trial_end
trial_from_plan
trial_period_days
trial_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create subscription item

Description

Tool to add a new item to an existing subscription without changing existing items. Use when adding a product or service to a customer's subscription.

Action Parameters

billing_thresholds
discounts
metadata
payment_behavior
price
price_data
proration_behavior
proration_date
quantity
subscription
stringRequired
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create tax rate

Description

Tool to create a new tax rate in Stripe. Use when you need to define a tax rate for invoices, subscriptions, or checkout sessions.

Action Parameters

active
country
description
display_name
stringRequired
inclusive
booleanRequired
jurisdiction
metadata
percentage
numberRequired
state
tax_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Terminal Location

Description

Creates a new Terminal Location for managing Stripe Terminal readers. Use when you need to register a physical location where Terminal readers will be deployed.

Action Parameters

address
objectRequired
configuration_overrides
display_name
metadata
phone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Terminal Reader

Description

Tool to create and register a new Terminal Reader to a Stripe account. Use when you need to add a new physical card reader device to a location for accepting in-person payments.

Action Parameters

label
location
stringRequired
metadata
registration_code
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Test Confirmation Token

Description

Tool to create a test mode Confirmation Token for server-side integration testing. Use when you need to test payment flows without real payment methods.

Action Parameters

payment_method
payment_method_data
payment_method_options
return_url
setup_future_usage
shipping

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create usage record

Description

Creates a usage record for a specified subscription item and timestamp. Use when tracking customer usage for metered billing plans to accurately invoice usage-based subscriptions.

Action Parameters

action
stringDefaults to increment
quantity
integerRequired
subscription_item
stringRequired
timestamp
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Apple Pay Domain

Description

Tool to delete an Apple Pay domain from a Stripe account. Use when you need to remove a previously registered Apple Pay domain. This operation is permanent and cannot be undone.

Action Parameters

domain
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete coupon

Description

Permanently deletes a coupon from Stripe account, preventing new redemptions. Use when you need to remove outdated or invalid discount codes. Note: existing customer redemptions remain unaffected.

Action Parameters

coupon_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete coupon

Description

Tool to delete a coupon from Stripe. Use when you need to remove a coupon code, preventing new redemptions while preserving existing customer discounts.

Action Parameters

coupon
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer

Description

Permanently deletes an existing Stripe customer; this irreversible action also cancels their active subscriptions and removes all associated data.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer discount

Description

Removes an active discount from a customer account. Use when you need to delete a customer's discount.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer

Description

Permanently deletes a customer and cancels active subscriptions. Use when you need to remove a customer record from your Stripe account. This operation is irreversible and automatically terminates any active subscriptions.

Action Parameters

customer
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer bank account

Description

Deletes a bank account payment source from a customer. Use when you need to remove a bank account from a customer's payment methods.

Action Parameters

customer
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer card

Description

Deletes a card from a customer's account. Use when you need to remove a card payment source from a customer.

Action Parameters

customer
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer discount

Description

Removes the currently applied discount on a customer. Use when you need to remove a coupon or promotion code discount from a customer's account.

Action Parameters

customer
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer tax ID

Description

Deletes a customer's tax ID object. Use when you need to remove a specific tax identification from a customer's account.

Action Parameters

customer
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel customer subscription

Description

Cancels a customer's subscription immediately. Customer won't be charged again, and subscription status becomes 'canceled'.

Action Parameters

customer
stringRequired
invoice_now
prorate
subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer subscription discount

Description

Removes currently applied discount from a customer's subscription. Use when you need to remove a discount code or promotion from a specific subscription belonging to a customer.

Action Parameters

customer
stringRequired
subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer tax ID

Description

Deletes an existing tax_id object from a customer. Use this when you need to remove a tax ID that was previously associated with a customer account.

Action Parameters

customer_id
stringRequired
tax_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete ephemeral key

Description

Immediately invalidate an ephemeral key. Use when you need to manually expire a short-lived API key before its automatic expiration time.

Action Parameters

key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete invoice item

Description

Deletes a Stripe invoice item, removing it from an invoice. Use when removing line items from draft invoices or unattached invoice items.

Action Parameters

invoiceitem_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete invoice item

Description

Tool to delete an invoice item from Stripe. Use when removing invoice items that are not attached to invoices or attached to draft invoices.

Action Parameters

invoiceitem
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete draft invoice

Description

Permanently deletes a draft invoice. This action cannot be undone. Use when you need to remove a draft invoice. Finalized or subscription invoices must be voided instead.

Action Parameters

invoice
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete plan

Description

Deletes a plan. Existing subscribers aren't affected; the change applies only to new subscriptions.

Action Parameters

plan_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete plan

Description

Tool to delete a plan from Stripe. Use when you need to permanently remove a pricing plan. Prevents new subscribers from being added to the plan, but existing subscribers remain unaffected.

Action Parameters

plan
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete product

Description

Delete a product. Deleting a product is only possible if it has no prices associated with it. Products with type=good cannot be deleted if they have SKUs.

Action Parameters

product_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete product feature

Description

Removes a feature from a product. Use when you need to delete a specific product feature attachment.

Action Parameters

id
stringRequired
product
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete subscription discount

Description

Removes the currently applied discount on a subscription. Use when you need to remove a discount code or promotion from an active subscription. Returns a deleted confirmation flag upon success.

Action Parameters

subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete subscription item

Description

Deletes an item from the subscription without canceling it. Use when removing a specific item from a multi-item subscription.

Action Parameters

clear_usage
boolean
proration_behavior
proration_date
subscription_item_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete subscription item

Description

Deletes a subscription item without canceling the subscription. Use when you need to remove a specific item from a customer's subscription while keeping the subscription active.

Action Parameters

clear_usage
item
stringRequired
proration_behavior
proration_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel subscription

Description

Immediately cancels a customer's subscription. Use when the customer no longer wants the service.

Action Parameters

cancellation_details
invoice_now
prorate
subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete subscription discount

Description

Removes currently applied discount from subscription. Use when you need to remove a discount code or promotion from an active subscription.

Action Parameters

subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete tax ID

Description

Deletes an existing tax ID object. Use when you need to permanently remove a customer's tax identification information from Stripe.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete tax ID

Description

Deletes an existing tax ID object. Use when you need to permanently remove a tax identification from Stripe.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Terminal Configuration

Description

Permanently deletes a Terminal Configuration object from your Stripe account. Use when you need to remove a configuration that defines how features should be configured for terminal readers.

Action Parameters

configuration
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Terminal Location

Description

Permanently deletes a Terminal Location object from your Stripe account. Use when you need to remove a physical location where Terminal readers are no longer deployed.

Action Parameters

location_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Terminal Location

Description

Tool to permanently delete a Terminal Location object from your Stripe account. Use when you need to remove a physical location where Terminal readers are no longer deployed. This operation is permanent and irreversible.

Action Parameters

location
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Terminal Reader

Description

Permanently deletes a Terminal Reader object from your Stripe account. Use when you need to remove a reader device that is no longer in use.

Action Parameters

reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete test clock

Description

Permanently deletes a test clock from Stripe's test environment. Use when you need to remove test clocks used for simulating time-based features.

Action Parameters

test_clock
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete customer

Description

Tool to permanently delete a Stripe customer. Use when you need to remove a customer and cancel all their active subscriptions.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Detach customer source

Description

Detaches a source from a customer. Upon detachment, the source status becomes 'consumed' and cannot be used for future charges. Use when you need to remove a payment source from a customer account.

Action Parameters

customer_id
stringRequired
source_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void an invoice

Description

Tool to void a finalized Stripe invoice. Use when you need to permanently mark an invoice as void to prevent any further collection attempts. This action cannot be undone.

Action Parameters

invoice_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete product feature

Description

Deletes a feature attachment from a product. Use when you need to remove a specific feature from a product. If the product feature ID does not exist, the API raises an error.

Action Parameters

feature_id
stringRequired
product_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel subscription

Description

Tool to cancel a Stripe subscription immediately. Use when you need to permanently cancel a customer's subscription and prevent future charges.

Action Parameters

cancellation_details
invoice_now
prorate
subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete terminal configuration

Description

Deletes a Configuration object from the Stripe Terminal system. Use when you need to permanently remove a terminal configuration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Terminal Reader

Description

Tool to permanently delete a Terminal Reader device from your Stripe account. Use when you need to remove a reader device that is no longer in use or needs to be decommissioned.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete test clock

Description

Deletes a test clock from Stripe's test environment. Use when you need to remove a test clock that is no longer needed for testing time-based features.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Detach payment method

Description

Detaches a PaymentMethod object from a Customer account. Use when you need to remove a payment method from a customer without deleting it entirely.

Action Parameters

payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Download Quote PDF

Description

Tool to download the PDF for a finalized quote from Stripe. Use when you need to retrieve the PDF representation of a quote that has been finalized.

Action Parameters

quote_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Finalize quote

Description

Tool to finalize a quote in Stripe. Use when you need to transition a quote from draft status to open status, making it ready to be sent to the customer for acceptance. The quote must have a customer attached before it can be finalized.

Action Parameters

expand
expires_at
quote
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Fund Test Mode Cash Balance

Description

Tool to fund a test mode cash balance for a customer. Use when you need to simulate incoming bank transfers in test mode. This endpoint creates a test mode bank transfer that funds a customer's cash balance without processing real money.

Action Parameters

amount
integerRequired
currency
stringRequired
customer_id
stringRequired
reference

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Account

Description

Retrieves detailed information for the authenticated Stripe account. Use when you need to access account capabilities, requirements, settings, or business profile.

Action Parameters

expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Account

Description

Retrieves the details of a Stripe account. Use when you need to check account properties like current requirements, live charge capability, payout eligibility, business details, or verification status.

Action Parameters

account
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Account Capabilities

Description

Retrieves a list of all capabilities for a connected Stripe account. Use when you need to check all available capabilities, their statuses, and requirements for an account.

Action Parameters

account
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Account Capability

Description

Retrieves a capability for a connected Stripe account. Use when you need to check the status, requirements, or configuration of a specific capability for an account.

Action Parameters

account
stringRequired
capability
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List all persons for an account

Description

Retrieves a list of people associated with the account's legal entity. Use when you need to list all persons for an account, with optional filtering by relationship type.

Action Parameters

account
stringRequired
ending_before
limit
relationship_authorizer
relationship_director
relationship_executive
relationship_legal_guardian
relationship_owner
relationship_representative
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Person from Account

Description

Retrieves an existing person associated with a Stripe account. Use when you need to check the details, verification status, or requirements of a specific person on an account.

Action Parameters

account
stringRequired
person
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Apple Pay Domain

Description

Retrieves details about a previously registered Apple Pay domain. Use when you need to fetch information about a specific Apple Pay domain that was registered with Stripe.

Action Parameters

domain
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Apple Pay domains

Description

Retrieves a list of Apple Pay domains registered with Stripe. Use when you need to fetch all registered Apple Pay domains with pagination support.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List apps secrets

Description

Tool to list all secrets stored on the given scope. Use when you need to retrieve secrets from the Secret Store API for Stripe Apps.

Action Parameters

ending_before
limit
scope_type
stringRequired
scope_user
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Find a secret by name and scope

Description

Tool to find a secret by name and scope in the Stripe Apps secret store. Use when you need to retrieve a specific secret's details based on its name and scope.

Action Parameters

name
stringRequired
scope
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Balance Transactions

Description

Tool to retrieve a list of balance transactions for your Stripe account. Use when you need to view transaction history affecting your balance. Returns all fund movements including charges, refunds, payouts, and fees with filtering options by date, currency, type, or source.

Action Parameters

created
currency
ending_before
limit
payout
source
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Balance Transaction

Description

Retrieves a specific balance transaction by its ID. Use this to get detailed information about funds moving through your Stripe account, including the gross amount, fees, net amount, and transaction status.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Balance Settings

Description

Tool to retrieve balance settings for a connected account. Use when you need to check payout schedules, settlement delays, or negative balance reclaim settings. This API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect.

Action Parameters

expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Balance Transaction

Description

Retrieves detailed information for a specific balance transaction using its unique ID. Use this when you need to fetch transaction details including amounts, fees, availability dates, and transaction sources.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List billing alerts

Description

Tool to retrieve a paginated list of billing alerts. Use when you need to view billing alerts that notify when usage thresholds on meters are crossed.

Action Parameters

alert_type
ending_before
limit
meter
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Billing Alert

Description

Retrieves a billing alert by its unique identifier. Use when you need to fetch details of a specific billing alert that notifies when a certain usage threshold on a meter is crossed.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Billing Credit Balance Summary

Description

Retrieves the credit balance summary for a customer in Stripe Billing. Use when you need to check available and ledger balances for billing credits.

Action Parameters

customer
customer_account
filter
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve credit balance transaction

Description

Retrieves a credit balance transaction by its unique identifier. Use when you need to get details about a specific credit or debit transaction against a credit grant.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List billing credit grants

Description

Tool to retrieve a paginated list of billing credit grants. Use when you need to view credit allocations for customers, track promotional credits, or manage billing credits.

Action Parameters

customer
customer_account
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve billing credit grant

Description

Retrieves a billing credit grant by its unique identifier. Use when you need to get details about a specific credit grant allocation for a customer.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List billing meters

Description

Tool to retrieve a list of billing meters from Stripe. Use when you need to list meters with optional filtering by status and pagination support.

Action Parameters

ending_before
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Billing Meter Event Summaries

Description

Retrieves billing meter event summaries for a customer within a time range. Use when you need to get aggregated event data for a specific billing meter and customer.

Action Parameters

customer
stringRequired
end_time
integerRequired
ending_before
id
stringRequired
limit
start_time
integerRequired
starting_after
value_grouping_window

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Billing Meter

Description

Retrieves a billing meter by its unique identifier. Use when you need to fetch configuration details and settings for a specific billing meter.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List billing meter event summaries

Description

Tool to retrieve list of billing meter event summaries, aggregating meter events within specified time range for a customer. Use when you need aggregated event data for billing meter analysis.

Action Parameters

customer
stringRequired
end_time
integerRequired
ending_before
id
stringRequired
limit
start_time
integerRequired
starting_after
value_grouping_window

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List portal configurations

Description

Tool to list billing portal configurations. Use when you need to retrieve portal configurations that describe the functionality and settings of the customer portal.

Action Parameters

active
ending_before
is_default
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get billing portal configuration

Description

Tool to retrieve a billing portal configuration from Stripe. Use when you need to fetch details about a specific portal configuration including branding, features, and settings.

Action Parameters

configuration
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a charge

Description

Tool to retrieve a charge from Stripe. Use when you need to get detailed information about a specific charge.

Action Parameters

charge
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Charge Dispute

Description

Tool to retrieve a dispute for a specified charge. Use when you need to get dispute details associated with a specific charge ID.

Action Parameters

charge
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Charge Refunds

Description

Tool to list all refunds for a specific charge. Use when you need to retrieve all refund transactions associated with a particular charge ID.

Action Parameters

charge
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Charge Refund Details

Description

Tool to retrieve the details of an existing refund within a specific charge. Use when you need to get refund information using both the charge ID and refund ID.

Action Parameters

charge
stringRequired
expand
refund
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Checkout Sessions

Description

Tool to retrieve a list of Stripe Checkout Sessions with pagination support. Use when you need to list checkout sessions, optionally filtering by customer, status, payment intent, or other criteria.

Action Parameters

created
customer
customer_account
customer_details_email
ending_before
limit
payment_intent
payment_link
starting_after
status
subscription

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get checkout session line items

Description

Tool to retrieve paginated line items for a Checkout Session. Use when you need to get detailed information about items purchased in a checkout session, including prices, quantities, discounts, and taxes.

Action Parameters

ending_before
limit
session_id
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Checkout Session

Description

Tool to retrieve a Checkout Session object from Stripe. Use when you need to get the current state of a checkout session, including payment status, customer details, and line items.

Action Parameters

expand
session
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Checkout Session Line Items

Description

Tool to retrieve line items for a Checkout Session. Use when you need to view the items, pricing, quantities, and totals for a specific checkout session.

Action Parameters

ending_before
limit
session
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Climate Orders

Description

Tool to list all Climate order objects. Use when you need to retrieve carbon removal orders sorted by creation date with most recent first.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List climate products

Description

Tool to retrieve a list of available Stripe Climate products. Use when you need to see carbon removal offerings with pricing and supplier information.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve climate product

Description

Tool to retrieve details of a specific Stripe Climate product. Use when you need to get information about a particular carbon removal product including pricing and supplier details.

Action Parameters

product
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List climate suppliers

Description

Tool to retrieve a list of available Stripe Climate supplier objects for carbon removal. Use when you need to see carbon removal providers including biomass carbon removal, direct air capture, and enhanced weathering.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve climate supplier

Description

Tool to retrieve a specific Stripe Climate supplier by ID. Use when you need detailed information about a carbon removal supplier's operations and technology.

Action Parameters

supplier
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Confirmation Token

Description

Tool to retrieve an existing ConfirmationToken object by its ID. Use when you need to access payment method details and customer information that were securely passed during the payment confirmation flow.

Action Parameters

confirmation_token
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List country specs

Description

Retrieves a list of country specifications available in the Stripe API. Use when you need details about supported currencies, payment methods, and verification requirements for specific countries.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Country Spec

Description

Retrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies. Use when you need country-specific payment capabilities.

Action Parameters

country
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a coupon

Description

Retrieves the coupon with the given ID. Use when you need to get details of a specific discount coupon.

Action Parameters

coupon
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Credit Note Lines

Description

Retrieves the paginated list of line items for a specific credit note. Use when you need complete details of all line items associated with a credit note.

Action Parameters

credit_note
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve a credit note

Description

Retrieves a credit note by its unique identifier. Use when you need to get detailed information about a specific credit note.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Preview Credit Note

Description

Tool to preview a credit note without creating it in Stripe. Use when you need to show what a credit note will contain before finalizing it.

Action Parameters

amount
credit_amount
effective_at
email_type
invoice
stringRequired
lines
memo
metadata
out_of_band_amount
reason
refund
refund_amount
shipping_cost

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Credit Note Preview Lines

Description

Tool to retrieve a credit note preview's line items from Stripe. Use when you need to see what line items would be included in a credit note before creating it.

Action Parameters

amount
credit_amount
effective_at
email_type
ending_before
invoice
stringRequired
limit
lines
memo
metadata
out_of_band_amount
reason
refund
refund_amount
shipping_cost
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Credit Notes Preview Lines

Description

Tool to retrieve paginated list of credit note preview line items. Use when you need full access to all line items beyond the limited set returned in standard preview requests.

Action Parameters

amount
credit_amount
effective_at
email_type
ending_before
invoice
stringRequired
limit
lines
memo
metadata
out_of_band_amount
reason
refund_amount
refunds
shipping_cost
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get customer bank accounts

Description

Retrieves a list of bank accounts for a given Stripe customer. Use when you need to access a customer's saved bank account payment methods with pagination support.

Action Parameters

customer_id
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer cash balance transaction

Description

Tool to retrieve a specific cash balance transaction that updated a customer's cash balance. Use when you need to get details about a particular cash balance transaction for a customer.

Action Parameters

customer
stringRequired
expand
transaction
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get customer details

Description

Tool to retrieve a customer by ID. Use when you need to get detailed information about a specific Stripe customer, including their contact details, payment methods, and subscription data.

Action Parameters

customer
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer balance transactions

Description

Tool to list customer balance transactions that updated a customer's balance. Use when you need to retrieve the history of balance changes for a specific customer.

Action Parameters

created
customer
stringRequired
ending_before
invoice
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Customer Balance Transaction

Description

Retrieves a specific customer balance transaction that updated the customer's balances. Use this when you need to fetch details about a particular balance transaction for a customer.

Action Parameters

customer
stringRequired
transaction
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer bank accounts

Description

Tool to list all bank accounts for a specific customer. Use when you need to retrieve bank account information for payments or verification purposes.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer bank account

Description

Retrieves details about a specific bank account stored on a Stripe customer. Use when you need to view bank account information for a customer.

Action Parameters

customer
stringRequired
expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List all cards

Description

Tool to list all cards for a customer. Use when you need to retrieve payment card information for a specific customer.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer card

Description

Retrieves details about a specific card for a customer. Use when you need to view card information stored on a customer account.

Action Parameters

customer
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get customer cash balance

Description

Tool to retrieve a customer's cash balance. Use when you need to check the current cash balance for a specific Stripe customer, including available funds by currency.

Action Parameters

customer
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer cash balance transactions

Description

Tool to list cash balance transactions for a specific customer. Use when you need to retrieve transaction history showing how funds moved in or out of a customer's cash balance. Supports pagination for large result sets.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get customer discount

Description

Tool to retrieve the discount currently active on a customer. Use when you need to check a customer's active discount details.

Action Parameters

customer
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List a Customer’s PaymentMethods

Description

Tool to list a customer's payment methods in Stripe. Use when you need to retrieve all payment methods associated with a specific customer.

Action Parameters

allow_redisplay
customer
stringRequired
ending_before
limit
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer’s payment method

Description

Tool to retrieve a specific PaymentMethod object for a given Customer. Use when you need to get detailed information about a particular payment method associated with a customer.

Action Parameters

customer
stringRequired
expand
payment_method
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer sources

Description

Tool to list sources for a specified customer. Use when you need to retrieve payment sources (cards) stored on a customer account.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer source

Description

Tool to retrieve a specified payment source for a given customer. Use when you need to get details about a specific card, bank account, or payment source attached to a customer. Note: The Sources API is deprecated; consider using PaymentMethods API for new integrations.

Action Parameters

customer
stringRequired
expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer subscriptions

Description

Tool to list active subscriptions for a specific Stripe customer. Use when you need to retrieve all subscription details for a given customer ID.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer subscription

Description

Tool to retrieve a specific subscription for a customer. Use when you need to get detailed information about a customer's subscription using both customer ID and subscription ID.

Action Parameters

customer
stringRequired
subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get customer subscription discount

Description

Tool to retrieve the discount currently applied to a customer's subscription. Use when you need to check if a subscription has an active discount and get details about the coupon or promotion code.

Action Parameters

customer
stringRequired
expand
subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer tax IDs

Description

Tool to retrieve all tax IDs for a specific Stripe customer. Use when you need to list tax identification numbers (VAT, GST, etc.) associated with a customer account.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve a customer tax ID

Description

Tool to retrieve a specific tax ID for a customer. Use when you need to fetch details about a customer's tax identification number.

Action Parameters

customer
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Disputes

Description

Tool to list all disputes from a Stripe account. Use when you need to retrieve disputes with optional filtering by charge or payment intent.

Action Parameters

charge
created
ending_before
limit
payment_intent
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Dispute

Description

Tool to retrieve a dispute. Use when you need to get detailed information about a specific Stripe dispute using its ID.

Action Parameters

dispute
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List active entitlements

Description

Retrieves a list of active entitlements for a customer. Use when you need to check which features a specific customer has access to.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve active entitlement

Description

Tool to retrieve an active entitlement by ID from Stripe. Use when you need to get details about a specific active entitlement that a customer has access to.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List entitlements features

Description

Retrieves a paginated list of entitlements features from Stripe. Use when you need to list monetizable abilities or functionalities in your system that can be assigned to products.

Action Parameters

archived
ending_before
limit
lookup_key
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve entitlements feature

Description

Tool to retrieve a feature by ID from Stripe. Use when you need to get details about a specific entitlements feature.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List events

Description

Retrieves a list of Stripe events from the past 30 days with filtering and pagination. Use to track API activity and monitor webhook deliveries.

Action Parameters

created
delivery_success
ending_before
limit
starting_after
type
types

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve event

Description

Retrieves event details for events created within the last 30 days. Use when you need to fetch webhook event information or verify event data.

Action Parameters

id
stringRequired

Action Response

account
api_version
context
created
integerRequired
data
objectRequired
error
id
stringRequired
livemode
booleanRequired
object
stringRequired
pending_webhooks
integerRequired
request
successful
booleanRequired
type
stringRequired

Tool Name: List files

Description

Tool to retrieve a list of files that your account has access to. Use when you need to list files uploaded to Stripe, with optional filtering by purpose or creation date.

Action Parameters

created
ending_before
limit
purpose
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve File

Description

Tool to retrieve details of an existing file object by its unique identifier. Use when you need to get information about a previously uploaded file.

Action Parameters

file
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Financial Connections Accounts

Description

Tool to list Financial Connections Account objects representing external financial accounts. Use when you need to retrieve accounts linked through Financial Connections.

Action Parameters

account_holder
ending_before
limit
session
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Financial Connections Session

Description

Retrieves the details of a Financial Connections Session. Use when you need to check the status or details of a session.

Action Parameters

session
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List forwarding requests

Description

Tool to list all ForwardingRequest objects from Stripe. Use when you need to retrieve forwarding requests with optional filtering by creation timestamp and pagination support.

Action Parameters

created
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Invoice Items

Description

Retrieves a paginated list of Stripe invoice items. Use to filter by customer, invoice, creation date, or attachment status with cursor-based pagination.

Action Parameters

created
customer
customer_account
ending_before
invoice
limit
pending
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Invoice Item

Description

Tool to retrieve the details of an invoice item using its unique identifier. Use when you need to fetch information about a specific invoice item.

Action Parameters

expand
invoiceitem
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve invoice payment

Description

Retrieves a specific invoice payment by ID. Use when you need to get details about a payment associated with a Stripe invoice.

Action Parameters

invoice_payment_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Invoice Rendering Templates

Description

Tool to list all invoice rendering templates ordered by creation date. Use when you need to retrieve available invoice rendering templates.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Invoice

Description

Tool to retrieve a specific invoice by ID. Use when you need to get detailed information about an existing invoice.

Action Parameters

expand
invoice
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Invoice Line Items

Description

Tool to retrieve a paginated list of line items for a specific invoice. Use when you need to see the individual charges, products, or services included in an invoice.

Action Parameters

ending_before
invoice
stringRequired
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Mandate

Description

Tool to retrieve a Stripe mandate by its ID. Use when you need to fetch details about a specific mandate, including customer acceptance information and payment method details.

Action Parameters

mandate
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Payment Attempt Records

Description

Tool to list payment attempt records for a specified payment record. Use when you need to retrieve all attempts made to process a specific payment.

Action Parameters

ending_before
limit
payment_record
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get payment intent details

Description

Tool to retrieve PaymentIntent details by ID. Use when you need to get the current state of a payment intent, including amount, status, and payment method information.

Action Parameters

client_secret
expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get payment intent amount details line items

Description

Tool to retrieve paginated line items for a PaymentIntent. Use when you need to get detailed product and service information including quantities, prices, discounts, and taxes for a specific payment intent.

Action Parameters

ending_before
limit
payment_intent_id
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve payment intent

Description

Tool to retrieve PaymentIntent details by ID. Use when you need to get the current state of a payment intent, including amount, status, and payment method information.

Action Parameters

client_secret
expand
intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List payment method configurations

Description

Retrieves all payment method configuration objects with optional filters for pagination and Connect applications. Use when you need to view available payment method settings.

Action Parameters

application
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired

Tool Name: Get payment method configuration

Description

Tool to retrieve payment method configuration details by ID. Use when you need to check which payment methods are available and displayed for new payments.

Action Parameters

configuration
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Payment Method Domain

Description

Retrieves details of an existing payment method domain. Use when you need to fetch information about a specific payment method domain registered with Stripe.

Action Parameters

payment_method_domain
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List payment methods

Description

Tool to retrieve a list of PaymentMethod objects with filtering and pagination support. Use when you need to list payment methods for Treasury flows or customer payment methods.

Action Parameters

allow_redisplay
customer
customer_account
ending_before
limit
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve a PaymentMethod

Description

Tool to retrieve a PaymentMethod object attached to the Stripe account. Use when you need to get details about a specific payment method using its unique identifier.

Action Parameters

expand
payment_method
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Payouts

Description

Lists Stripe payouts sent to external accounts or received from Stripe, sorted by creation date descending (newest first), with optional filtering by arrival date, creation date, destination, and status.

Action Parameters

arrival_date
created
destination
ending_before
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve a payout

Description

Tool to retrieve details of an existing Stripe payout. Use when you need to fetch information about a specific payout by its unique identifier.

Action Parameters

payout
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve plan

Description

Tool to retrieve a plan from Stripe. Use when you need to fetch details of a specific pricing plan. Note: The Plans API is superseded by the Prices API.

Action Parameters

plan
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a price

Description

Retrieves detailed information for a specific Stripe price using its unique ID. Use when you need to fetch price details.

Action Parameters

price
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a product

Description

Retrieves detailed information for an existing Stripe product using its unique product ID. Use when you need to fetch details about a specific product.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List product features

Description

Retrieves a list of features attached to a product. Returns a paginated list of product_feature objects representing attachments between features and products.

Action Parameters

ending_before
limit
product
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve product feature

Description

Retrieves a specific product feature by its ID. Use when you need to get details about a particular feature attached to a product.

Action Parameters

id
stringRequired
product
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Stripe promotion codes

Description

Retrieves a list of promotion codes from a Stripe account with optional filters for active status, code value, coupon association, and customer restrictions. Supports cursor-based pagination.

Action Parameters

active
code
coupon
created
customer
customer_account
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve promotion code

Description

Tool to retrieve a promotion code object by ID. Use when you need to get details about a specific promotion code. Note: To retrieve a promotion code by the customer-facing code string, use the list endpoint with the code as a filter instead.

Action Parameters

expand
promotion_code
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get quote details

Description

Tool to retrieve a quote by ID. Use when you need to get detailed information about a specific Stripe quote, including line items, pricing, and status.

Action Parameters

expand
quote
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Quote Computed Upfront Line Items

Description

Tool to retrieve computed upfront line items for a quote. Use when you need the full paginated list of upfront line items with detailed pricing information including amounts, taxes, and discounts.

Action Parameters

ending_before
limit
quote
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Quote Line Items

Description

Tool to retrieve a paginated list of line items for a quote. Use when you need to get details about the items included in a specific Stripe quote.

Action Parameters

ending_before
limit
quote
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Download Quote PDF

Description

Tool to download the PDF for a finalized quote from Stripe. Use when you need to retrieve the PDF document of a quote that has been finalized.

Action Parameters

quote
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Radar Early Fraud Warnings

Description

Tool to list all early fraud warnings from Stripe Radar. Use when you need to retrieve fraud warnings for charges, optionally filtered by charge ID or payment intent ID.

Action Parameters

charge
created
ending_before
limit
payment_intent
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Radar value list items

Description

Tool to list all value list items from a Stripe Radar value list. Use when you need to retrieve items from a specific value list for fraud detection rules. Returns items sorted by creation date in descending order with pagination support.

Action Parameters

created
ending_before
limit
starting_after
value
value_list
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Radar value lists

Description

Tool to list all Radar value lists. Use when you need to retrieve or search for value lists used in Stripe Radar rules.

Action Parameters

alias
contains
created
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Radar value list

Description

Tool to retrieve a Radar value list by its unique identifier. Use when you need to access value list details for fraud prevention rules.

Action Parameters

value_list
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a refund

Description

Tool to retrieve details of a specific Stripe refund by ID. Use when you need to get information about an existing refund.

Action Parameters

refund
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Report Runs

Description

Lists Stripe Report Runs, sorted by creation date descending (newest first). Use when you need to retrieve reporting data or check the status of report generation tasks.

Action Parameters

created
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve a Report Run

Description

Retrieves details of an existing Report Run object. Use when you need to check the status or retrieve results of a report run.

Action Parameters

report_run
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List reporting report types

Description

Retrieves a full list of Report Types available in Stripe. Use when you need to discover what types of reports can be generated through the Reporting API.

Action Parameters

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Report Type

Description

Tool to retrieve details of a specific Report Type. Use when you need information about a report type's availability, columns, or version.

Action Parameters

report_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List setup attempts

Description

Tool to list SetupAttempts associated with a SetupIntent. Use when you need to retrieve all setup attempts for a specific SetupIntent to understand the payment method setup process and any errors that occurred.

Action Parameters

created
ending_before
limit
setup_intent
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve setup intent

Description

Retrieves a SetupIntent by its ID. Use when you need to check the status or details of a previously created SetupIntent.

Action Parameters

client_secret
expand
intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve source

Description

Retrieves an existing source object. Use when you need to fetch up-to-date information about a specific source.

Action Parameters

client_secret
source_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve subscription item

Description

Retrieves detailed information for a specific Stripe subscription item using its unique ID.

Action Parameters

expand
item
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List subscription schedules

Description

Tool to list subscription schedules in Stripe. Use when you need to retrieve subscription schedules with optional filtering by customer, status, or date ranges, with support for cursor-based pagination.

Action Parameters

canceled_at
completed_at
created
customer
customer_account
ending_before
limit
released_at
scheduled
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve subscription schedule

Description

Retrieve a subscription schedule using its unique identifier. Use when you need to view details of an existing schedule including phases, settings, and status.

Action Parameters

expand
schedule
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve subscription by ID

Description

Tool to retrieve a subscription by its ID. Use when you need to get detailed information about a specific Stripe subscription.

Action Parameters

expand
subscription_exposed_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find tax association

Description

Tool to find a tax association by PaymentIntent ID. Use when you need to retrieve tax calculation and transaction details linked to a specific payment.

Action Parameters

payment_intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Tax Calculation

Description

Tool to retrieve a Tax Calculation object from Stripe. Use when you need to fetch details of a previously created tax calculation. The calculation must not have expired (expires after 90 days).

Action Parameters

calculation
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Tax Calculation Line Items

Description

Retrieves line items of a tax calculation as a paginated collection. Use this to see detailed tax information for each item in the calculation, including amounts, tax breakdowns, and tax rates.

Action Parameters

calculation
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get tax calculation line items

Description

Retrieves line items of a tax calculation as a paginated collection if not expired. Use when you need to view the detailed breakdown of items in a tax calculation.

Action Parameters

ending_before
id
stringRequired
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve tax code

Description

Retrieves the details of an existing tax code. Use when you need to get information about a specific tax code by its ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List tax IDs

Description

Retrieves a list of tax IDs for an account or customer. Use when you need to view all tax IDs associated with the authenticated account or a specific owner.

Action Parameters

ending_before
expand
limit
owner
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve tax ID

Description

Retrieves an account or customer tax ID object. Use when you need to get details about a specific tax identification number stored in Stripe.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a tax rate

Description

Tool to retrieve the details of an existing tax rate. Use when you need to fetch information about a specific tax rate by its ID.

Action Parameters

tax_rate
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List tax registrations

Description

Retrieves a paginated list of tax registrations. Use when you need to view where a business is registered to collect tax on payments within various regions.

Action Parameters

ending_before
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve tax registration

Description

Tool to retrieve a specific tax registration configured for your Stripe account. Use when you need to get details about where and how taxes are collected across different jurisdictions.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Tax Settings

Description

Retrieves Tax Settings for a merchant. Use when you need to fetch the tax configuration for a Stripe account.

Action Parameters

expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get tax transaction line items

Description

Tool to retrieve line items of a committed standalone tax transaction as a collection. Use when you need to view the detailed breakdown of line items for a specific tax transaction.

Action Parameters

ending_before
limit
starting_after
transaction_id
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Tax Transaction

Description

Retrieves a Tax Transaction object by ID. Use when you need to fetch details about a specific tax transaction.

Action Parameters

transaction
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get tax transaction line items

Description

Retrieves the line items of a committed standalone tax transaction. Use when you need to view detailed line-by-line breakdown of a tax transaction.

Action Parameters

ending_before
expand
limit
starting_after
transaction
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List terminal configurations

Description

Tool to retrieve a list of Terminal Configuration objects from Stripe. Use when you need to view all terminal configurations with optional filtering and pagination.

Action Parameters

ending_before
is_account_default
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve terminal configuration

Description

Tool to retrieve a specific Terminal Configuration object from Stripe. Use when you need to view the detailed settings for a specific terminal configuration by its ID.

Action Parameters

configuration
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List terminal locations

Description

Retrieves a list of Stripe terminal locations with pagination support. Use when you need to view all terminal locations for managing physical card readers.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Terminal Location

Description

Tool to retrieve a Terminal Location object by ID. Use when you need to get details about a specific terminal location for managing card readers.

Action Parameters

expand
location
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List terminal readers

Description

Tool to list all Stripe Terminal Readers with optional filtering. Use when you need to retrieve readers by device type, location, serial number, or status.

Action Parameters

device_type
ending_before
limit
location
serial_number
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Terminal Reader

Description

Tool to retrieve a Terminal Reader object by ID. Use when you need to get details about a specific reader device for accepting payment details in Stripe Terminal.

Action Parameters

expand
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve test clock

Description

Tool to retrieve a test clock by ID. Use when testing billing integrations by simulating time advancement in sandbox environments.

Action Parameters

test_clock
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Token

Description

Retrieves the token with the given ID. Use when you need to verify token details or check if a token has been used.

Action Parameters

token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Top-ups

Description

Tool to retrieve a list of existing top-ups from Stripe. Use when you need to view top-ups with optional filtering by amount, status, or creation date, and pagination support.

Action Parameters

amount
created
ending_before
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List transfers

Description

List all transfers sent to connected accounts. Transfers are returned in reverse chronological order. Use when you need to retrieve transfer history or monitor funds sent to connected accounts.

Action Parameters

created
destination
ending_before
limit
starting_after
transfer_group

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Account Capability

Description

Retrieves information about a specific capability for a Stripe account. Use when you need to check the status, requirements, or configuration of a capability such as card payments, transfers, or ACH payments.

Action Parameters

account_id
stringRequired
capability_id
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Account Capabilities

Description

Retrieves a list of all capabilities for a Stripe account. Use when you need to check payment functionalities (like card payments, transfers) and their statuses for an account.

Action Parameters

account_id
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Application Fees Overview

Description

Tool to retrieve an overview of application fees from Stripe. Use when you need a quick summary of recent application fees with default limit of 3.

Action Parameters

charge
ending_before
limit
Defaults to 3
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get balance settings overview

Description

Tool to retrieve balance settings for a Stripe account. Use when you need to fetch configuration options for customizing account balances and payout settings for a connected account or the authenticated account.

Action Parameters

stripe_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Balance Transaction

Description

Retrieves the balance transaction with the given ID. Use when you need detailed information about a specific balance transaction including amounts, fees, availability dates, and transaction sources.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Balance Transactions

Description

Lists balance transactions for a Stripe account sorted by creation date descending. Use to retrieve transactions that have contributed to your Stripe account balance with filtering and pagination support.

Action Parameters

created
currency
ending_before
limit
payout
source
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get V1 Billing Credit Balance Summary Overview

Description

Tool to retrieve the credit balance summary for a customer showing available and ledger balances. Use when you need to check billing credit balances for a specific customer or applicability scope.

Action Parameters

customer
customer_account
filter
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve billing credit balance transaction

Description

Retrieves a credit balance transaction representing a credit or debit against an existing credit grant. Use when you need details about a specific billing credit balance transaction.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List credit balance transactions

Description

Tool to retrieve a paginated list of credit balance transactions with optional filtering. Use when you need to view credit and debit transactions for customer credit grants or track billing credit activity.

Action Parameters

credit_grant
customer
customer_account
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List billing credit grants

Description

Tool to retrieve a paginated list of billing credit grants. Use when you need to view credit allocations for customers or track promotional credits.

Action Parameters

customer
customer_account
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve billing credit grant

Description

Tool to retrieve a billing credit grant by its unique identifier. Use when you need to get details about a specific credit grant allocation for a customer.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List billing portal configurations

Description

Tool to retrieve a list of billing portal configurations that define customer portal functionality. Use when you need to view or manage portal configurations including subscription management, payment method updates, invoice history, and cancellation options.

Action Parameters

active
ending_before
is_default
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get billing portal configuration

Description

Tool to retrieve a billing portal configuration that describes customer portal functionality. Use when you need to view the settings for a specific billing portal configuration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get charge object

Description

Tool to retrieve the Charge object by its unique identifier. Use when you need to get details about a specific charge including payment status, amount, and transaction information.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get climate product overview

Description

Tool to retrieve details of a specific Stripe Climate product by ID. Use when you need information about a specific carbon removal unit's pricing, availability, and suppliers.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get climate supplier

Description

Tool to retrieve detailed information about a specific Stripe Climate supplier. Use when you need to get supplier details including name, removal pathway, locations, and additional information.

Action Parameters

supplier_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Country Spec

Description

Retrieves country spec details for a specific country code. Use when you need information about Stripe's supported features, currencies, payment methods, and verification requirements for a particular country.

Action Parameters

country_code
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List country specifications

Description

Retrieves a list of country specification objects. Use when you need country-specific configuration including supported currencies, payment methods, and verification requirements.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Credit Note

Description

Tool to retrieve credit note details from Stripe. Use when you need to get information about a specific credit note including amounts, line items, and status.

Action Parameters

credit_note_id
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Credit Note Lines

Description

Tool to retrieve paginated list of line items for a credit note. Use when you need to view detailed breakdown of items being credited in a Stripe credit note.

Action Parameters

ending_before
id
stringRequired
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Preview Credit Note

Description

Tool to preview a credit note without creating it in Stripe. Use when you need to see what a credit note will contain before issuing it.

Action Parameters

amount
credit_amount
effective_at
email_type
invoice
stringRequired
lines
memo
metadata
out_of_band_amount
reason
refund_amount
refunds
shipping_cost

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Customer Balance Transactions

Description

Retrieves paginated list of customer balance transactions. Use to view transaction history that has affected a customer's account balance.

Action Parameters

created
ending_before
id
stringRequired
invoice
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve customer balance transaction

Description

Tool to retrieve a specific customer balance transaction. Use when you need to view details of a transaction that updated a customer's balance, including adjustments, payments, and credits.

Action Parameters

customer_id
stringRequired
transaction_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Customer Bank Account

Description

Tool to retrieve a specific bank account belonging to a customer. Use when you need detailed information about a customer's bank account for payment processing or verification purposes.

Action Parameters

bank_account_id
stringRequired
customer_id
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a card

Description

Creates a new card for a customer in Stripe. Use when adding a payment card to a customer's account for future transactions.

Action Parameters

customer_id
stringRequired
metadata
source
Required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer payment methods

Description

Tool to list all payment methods for a specific Stripe customer. Use when you need to retrieve a customer's saved payment methods, with optional filtering by type and pagination support.

Action Parameters

allow_redisplay
customer_id
stringRequired
ending_before
limit
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get customer payment method

Description

Retrieves a specific PaymentMethod attached to a customer. Use when you need details about a saved payment method.

Action Parameters

customer_id
stringRequired
payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Stripe customers

Description

Tool to search for Stripe customers using Stripe's Search Query Language. Use when you need to find customers by email, metadata, creation date, or other customer attributes.

Action Parameters

limit
page
query
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
next_page
object
stringRequired
successful
booleanRequired
total_count
url
stringRequired

Tool Name: Retrieve customer tax ID

Description

Retrieves a specific tax ID object for a customer. Use when you need to get details about a specific tax identification number associated with a customer.

Action Parameters

customer_id
stringRequired
tax_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List customer tax IDs

Description

Tool to retrieve all tax IDs for a specific customer. Use when you need to view tax identification numbers (VAT, GST, etc.) associated with a customer.

Action Parameters

customer_id
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Dispute Details

Description

Retrieves detailed information for an existing Stripe dispute by ID. Use when you need to get complete dispute details including evidence, status, and payment information.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve active entitlement

Description

Tool to retrieve an active entitlement describing customer access to a feature. Use when you need to check specific entitlement details for a customer.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Financial Connections Session

Description

Tool to retrieve a Financial Connections Session by its identifier. Use when you need to check the status or details of a financial connections session.

Action Parameters

session_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Financial Connections Accounts Overview

Description

Tool to retrieve an overview of Financial Connections accounts from Stripe. Use when you need a quick summary of linked external financial accounts with default limit of 3.

Action Parameters

account_holder
ending_before
limit
Defaults to 3
session
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve FX Quote

Description

Tool to retrieve a specific FX Quote by its unique identifier. Use when you need to view Stripe's current exchange rate for currency pairs or check locked exchange rates.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List FX quotes

Description

Retrieves a list of FX quotes that have been issued, with the most recent appearing first. Use for locking exchange rates for payments or transfers.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get invoice item overview

Description

Tool to retrieve detailed information for a specific Stripe invoice item. Use when you need to fetch complete details about an invoice item by its ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Invoice Payment

Description

Retrieves an InvoicePayment by its ID showing payment-invoice mapping. Use when tracking if a payment is associated with a specific invoice and monitoring allocation details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Invoice Payments

Description

Tool to list invoice payments in Stripe with pagination and filtering options. Use when you need to retrieve payment records associated with invoices.

Action Parameters

ending_before
invoice
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List invoice rendering templates

Description

Tool to retrieve a list of invoice rendering templates from Stripe. Use when you need to view all available invoice templates, paginated with customizable limits.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Invoice Lines Overview

Description

Tool to retrieve paginated line items for a specific Stripe invoice. Use when you need to view the detailed breakdown of charges, subscriptions, or invoice items for a given invoice.

Action Parameters

ending_before
invoice_id
stringRequired
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve payment method configuration

Description

Tool to retrieve a specific payment method configuration by its unique identifier. Use when you need to inspect the settings and availability of payment methods for a given configuration.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List payment method configurations

Description

Tool to list all payment method configurations in a Stripe account. Use when you need to retrieve available payment method settings with optional pagination and filtering.

Action Parameters

application
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired

Tool Name: List payment method domains

Description

Tool to retrieve list of payment method domains registered with Stripe account. Use when you need to list all payment method domain objects with optional filtering by domain name and enabled status.

Action Parameters

domain_name
enabled
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Payment Method Domain

Description

Retrieves details of an existing payment method domain. Use when you need to fetch information about a specific payment method domain registered with Stripe.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve payment method

Description

Tool to retrieve a PaymentMethod object attached to the StripeAccount. Use when you need to fetch details of a specific payment method using its unique identifier.

Action Parameters

expand
payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List payment methods

Description

Tool to retrieve a list of PaymentMethods with filtering and pagination support. Use when you need to list payment methods, optionally filtering by customer, type, or redisplay settings.

Action Parameters

allow_redisplay
customer
customer_account
ending_before
limit
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve plan

Description

Tool to retrieve a specific Stripe plan by its unique identifier. Use when you need to view plan details including pricing, billing frequency, and configuration.

Action Parameters

plan_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a price

Description

Tool to create a new Stripe Price for a product. Use when defining pricing (one-time or recurring) for a product. Requires either an existing product ID or product_data to create a new product inline.

Action Parameters

active
billing_scheme
currency
stringRequired
currency_options
custom_unit_amount
lookup_key
metadata
nickname
product
product_data
recurring
tax_behavior
tiers
tiers_mode
transfer_lookup_key
transform_quantity
unit_amount
unit_amount_decimal

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List product features

Description

Tool to retrieve all features associated with a product. Use when you need to list features attached to a specific product.

Action Parameters

ending_before
limit
product_id
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve promotion code

Description

Retrieves a Stripe promotion code by its unique identifier. Use when you need to fetch details about a specific promotion code including its redemption status and restrictions.

Action Parameters

promotion_code_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List all computed upfront line items for a quote

Description

Tool to list all computed upfront line items for a specific quote. Use when you need to retrieve the paginated list of line items with detailed pricing, discounts, and tax information for a quote.

Action Parameters

ending_before
id
stringRequired
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List quote line items

Description

Tool to list all line items for a specific quote. Use when you need to retrieve the paginated list of items associated with a quote.

Action Parameters

ending_before
limit
quote_id
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Radar Early Fraud Warnings

Description

Returns a list of early fraud warnings. An early fraud warning indicates that the card issuer has notified Stripe that a charge may be fraudulent. Use when you need to review potentially fraudulent charges to decide whether to refund them proactively.

Action Parameters

charge
created
ending_before
expand
limit
payment_intent
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Radar Value List

Description

Retrieves a specific Stripe Radar value list by its identifier. Use when you need to fetch detailed information about a value list used in Radar rules.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Radar value lists overview

Description

Tool to retrieve an overview of Radar value lists. Use when you need to get a list of value lists used in Stripe Radar for fraud prevention.

Action Parameters

alias
contains
created
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve a refund

Description

Tool to retrieve details of an existing refund by ID. Use when you need to check the status, amount, or other details of a specific refund.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Report Type

Description

Retrieves details of a Report Type. Use when you need to understand metadata about a specific report type including data availability periods and default columns.

Action Parameters

report_type_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get reporting report types overview

Description

Tool to list all available Stripe report types. Use when you need to discover what reporting types are available for generating reports.

Action Parameters

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Get Shipping Rates Overview

Description

Tool to retrieve an overview of shipping rates from Stripe. Use when you need a quick summary of recent shipping rates with default limit of 3.

Action Parameters

active
currency
ending_before
limit
Defaults to 3
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List subscription schedules

Description

Retrieves a list of subscription schedules with optional filtering and pagination capabilities. Use to view scheduled subscription changes for customers.

Action Parameters

canceled_at
completed_at
created
customer
customer_account
ending_before
limit
released_at
scheduled
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List subscriptions

Description

Tool to retrieve a list of Stripe subscriptions with optional filtering. Use when you need to fetch subscriptions by customer, status, price, or other criteria.

Action Parameters

automatic_tax
collection_method
created
current_period_end
current_period_start
customer
customer_account
ending_before
limit
price
starting_after
status
test_clock

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Tax Calculation

Description

Retrieves a Tax Calculation object by its unique ID. Use when you need to access tax calculation details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve tax code

Description

Retrieves details of an existing tax code. Use when you need information about a specific tax classification.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get tax codes

Description

Tool to retrieve all tax codes available to add to Products for specific tax calculations. Use when you need to list available Stripe tax codes for product classification.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve tax ID

Description

Retrieves an account or customer tax_id object. Use when you need detailed information about a specific tax ID including its type, value, verification status, and owner details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List tax IDs

Description

Tool to retrieve a list of tax IDs with pagination support. Use when you need to list tax IDs for accounts or customers in Stripe.

Action Parameters

ending_before
limit
owner_account
owner_customer
owner_customer_account
owner_type
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve tax rate

Description

Tool to retrieve a specific tax rate by its unique ID. Use when you need detailed information about a particular tax rate.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get tax rates

Description

Tool to retrieve all tax rates with pagination support. Use when you need to list Stripe tax rates with optional filters for active status, inclusive/exclusive type, and creation date.

Action Parameters

active
created
ending_before
inclusive
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Retrieve Tax Transaction

Description

Tool to retrieve a specific tax transaction from Stripe Tax. Use when you need detailed information about a tax calculation or transaction.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get terminal configuration

Description

Tool to retrieve a terminal configuration by ID from Stripe. Use when you need to view the configuration settings for a specific terminal reader.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a test clock

Description

Tool to delete a test clock from Stripe's test environment. Use when you need to remove test clocks used for simulating time-based features.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete test clock

Description

Tool to delete a test clock from Stripe's test environment. Use when you need to remove test clocks used for simulating time-based features in testing.

Action Parameters

test_clock
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a v2 core event

Description

Tool to retrieve a v2 core event from Stripe. Use when you need to get comprehensive information about a specific event in the Stripe system, including changes, context, related objects, and event metadata.

Action Parameters

id
stringRequired

Action Response

changes
context
created
integerRequired
data
error
id
stringRequired
livemode
booleanRequired
object
stringRequired
reason
related_object
successful
booleanRequired
type
stringRequired

Tool Name: Retrieve V2 Core Event

Description

Retrieves detailed information about a specific event from Stripe V2 Core Events API. Use when you need to fetch event details including metadata and related objects.

Action Parameters

id
stringRequired

Action Response

changes
context
created
stringRequired
data
error
id
stringRequired
livemode
booleanRequired
object
stringRequired
reason
related_object
successful
booleanRequired
type
stringRequired

Tool Name: List active entitlements

Description

Tool to retrieve active entitlements for a customer. Use when you need to check which features a customer currently has access to.

Action Parameters

customer
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List subscription item period summaries

Description

Tool to list all subscription item period summaries. Use when you need to retrieve usage information for a specific subscription item over billing periods. Returns summaries sorted in reverse-chronological order (newest first), with the first item representing the most current usage period.

Action Parameters

ending_before
expand
limit
starting_after
subscription_item
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Application Fees

Description

Returns a list of application fees you've previously collected, sorted by creation date descending (newest first). Use when you need to retrieve application fees with optional filtering by charge and pagination support.

Action Parameters

charge
created
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Balance Transactions

Description

Lists Stripe balance transactions sorted by creation date descending (newest first), with optional filtering by currency, type, source, or payout and pagination support. Use to retrieve transactions that have contributed to your Stripe account balance.

Action Parameters

created
currency
ending_before
limit
payout
source
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List customer bank accounts

Description

Tool to fetch all bank accounts linked to a customer. Use when you need to retrieve payment source information for a specific customer.

Action Parameters

customer_id
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List cash balance transactions

Description

Tool to retrieve a list of cash balance transactions for a customer. Use when you need to view the history of cash balance changes for a specific Stripe customer, including funds added and payments applied.

Action Parameters

customer_id
stringRequired
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Charges

Description

Retrieves a list of Stripe charges with filtering and pagination; use valid cursor IDs from previous responses for pagination, and note that charges are typically returned in reverse chronological order.

Action Parameters

created
customer
ending_before
limit
payment_intent
starting_after
transfer_group

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Stripe coupons

Description

Retrieves a list of discount coupons from a Stripe account, supporting pagination via `limit`, `starting_after`, and `ending_before`.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Credit Notes

Description

Lists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support.

Action Parameters

created
customer
customer_account
ending_before
invoice
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List customer payment methods

Description

Retrieves a list of payment methods for a given customer, supporting type filtering and pagination.

Action Parameters

allow_redisplay
customer_id
stringRequired
ending_before
limit
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List customers

Description

Retrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination.

Action Parameters

created
object
email
string
ending_before
string
limit
integer
starting_after
string
test_clock
string

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List files

Description

Retrieves a list of files uploaded to Stripe. Use when you need to view or manage uploaded files with optional filtering by purpose and creation date.

Action Parameters

created
ending_before
limit
purpose
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Invoice Payments

Description

Tool to list all payments for invoices in Stripe. Use when you need to retrieve payment information associated with invoices, including pagination and filtering by invoice ID, status, or creation date.

Action Parameters

created
ending_before
invoice
limit
starting_after
status

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Invoices

Description

Retrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses.

Action Parameters

collection_method
string
created
object
customer
string
ending_before
string
limit
integer
starting_after
string
status
string
subscription
string

Action Response

data
arrayRequired
error
hasMore
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List payment intents

Description

Tool to list PaymentIntents from Stripe. Use when you need to retrieve a list of payment intents with optional filtering by customer, creation date, or pagination parameters.

Action Parameters

created
customer
customer_account
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List payment method domains

Description

Tool to retrieve a list of payment method domains and their configuration details. Use when you need to view which payment methods are enabled for registered domains.

Action Parameters

domain_name
enabled
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List plans

Description

Tool to list all billing plans from Stripe account. Use when you need to retrieve plans for subscription management or display available pricing options.

Action Parameters

active
created
ending_before
limit
product
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List prices

Description

Tool to list Stripe prices. Use when you need to retrieve and filter price objects before processing write operations.

Action Parameters

active
created
currency
ending_before
expand
limit
lookup_keys
product
recurring
starting_after
type

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List products

Description

Retrieves a list of Stripe products, with optional filtering and pagination; `starting_after`/`ending_before` cursors must be valid product IDs from a previous response.

Action Parameters

active
boolean
created
object
ending_before
string
ids
array
limit
integer
shippable
boolean
starting_after
string
url
string

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Stripe promotion codes

Description

Tool to retrieve a list of promotion codes from Stripe. Use when you need to view, filter, or paginate through promotion codes with optional filters for active status, code, coupon, customer, or creation date.

Action Parameters

active
code
coupon
created
customer
customer_account
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Quote Computed Upfront Line Items

Description

Tool to retrieve paginated upfront line items for a Stripe quote. Use when you need to get detailed information about charges that would be due immediately upon quote acceptance.

Action Parameters

ending_before
limit
quote_id
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Quote Line Items

Description

Retrieve paginated list of line items for a quote. Use when you need to access the full list of items included in a Stripe quote beyond the first handful available in the quote object.

Action Parameters

ending_before
expand
limit
quote
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Quotes

Description

Retrieves a list of Stripe quotes with pagination support. Use to fetch quotes by customer, status, or creation date.

Action Parameters

created
customer
customer_account
ending_before
limit
starting_after
status
test_clock

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Radar Value List Items

Description

Tool to list all value list items for a Stripe Radar value list. Use when you need to retrieve items from a specific Radar value list, with optional filtering by value or creation date and support for pagination.

Action Parameters

created
ending_before
limit
starting_after
value
value_list
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Refunds

Description

Lists Stripe refunds, sorted by creation date descending (newest first), with optional filtering by charge or payment_intent and pagination support.

Action Parameters

charge
ending_before
limit
payment_intent
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List open reviews

Description

Retrieves a list of open Stripe reviews with pagination support. Use when you need to access reviews that require action, sorted by creation date with most recent first.

Action Parameters

created
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List SetupAttempts

Description

Tool to list SetupAttempts associated with a SetupIntent. Use when you need to retrieve attempts to confirm a SetupIntent and attach a payment method to a customer.

Action Parameters

created
ending_before
limit
setup_intent
stringRequired
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List setup intents

Description

Tool to list SetupIntents from Stripe. Use when you need to retrieve a list of setup intents with optional filtering by customer, payment method, or pagination parameters.

Action Parameters

attach_to_self
created
customer
ending_before
limit
payment_method
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List Stripe shipping rates

Description

Retrieves a list of Stripe shipping rates, filterable by active status, creation date, and currency; useful for managing or displaying shipping options.

Action Parameters

active
created
currency
ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List subscription items

Description

Tool to list all subscription items for a given subscription. Use when you need to retrieve the items associated with a specific Stripe subscription.

Action Parameters

ending_before
limit
starting_after
subscription
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List subscriptions

Description

Retrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination.

Action Parameters

automatic_tax
object
collection_method
string
created
object
current_period_end
object
current_period_start
object
customer
string
ending_before
string
limit
integer
price
string
starting_after
string
status
string
test_clock
string

Action Response

data
arrayRequired
error
hasMore
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List tax codes

Description

Retrieves a paginated list of globally available, predefined Stripe tax codes used for classifying products and services in Stripe Tax.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List tax rates

Description

Retrieves a list of tax rates, which are returned sorted by creation date in descending order.

Action Parameters

active
created
ending_before
inclusive
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: List test clocks

Description

Retrieves a paginated list of test clocks. Use when you need to view all test clocks for testing time-dependent functionality.

Action Parameters

ending_before
limit
starting_after

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Update Account Capability

Description

Updates an existing account capability by modifying its request status. Use when you need to request a new capability or remove a non-permanent capability for a connected account.

Action Parameters

account
stringRequired
capability
stringRequired
experimental
requested

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update payment intent

Description

Tool to update properties on a Stripe PaymentIntent without confirming it. Use when you need to modify payment details like amount, description, or metadata before the payment is confirmed.

Action Parameters

amount
application_fee_amount
capture_method
confirm
currency
customer
customer_account
description
id
stringRequired
metadata
off_session
payment_method
payment_method_types
receipt_email
return_url
setup_future_usage
shipping
statement_descriptor
statement_descriptor_suffix
transfer_group

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Apple Pay Domain

Description

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.

Action Parameters

domain_name
stringRequired
expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create apps secret

Description

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.

Action Parameters

expires_at
name
stringRequired
payload
stringRequired
scope_type
stringRequired
scope_user

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete apps secret

Description

Tool to delete a secret from Stripe Apps Secret Store by name and scope. Use when you need to remove a secret that is no longer needed or needs to be rotated.

Action Parameters

name
stringRequired
scope_type
stringRequired
scope_user

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Balance Settings

Description

Updates balance settings for a connected account. Use when customizing payout schedules, settlement timing, or negative balance handling.

Action Parameters

payments

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create billing alert

Description

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.

Action Parameters

alert_type
stringRequired
title
stringRequired
usage_threshold
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Activate billing alert

Description

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.

Action Parameters

alert_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Archive billing alert

Description

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.

Action Parameters

alert_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Deactivate billing alert

Description

Tool to deactivate a billing alert, preventing it from triggering. Use when you need to stop a billing alert from monitoring usage thresholds.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create billing credit grant

Description

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.

Action Parameters

amount
objectRequired
applicability_config
objectRequired
category
customer
customer_account
effective_at
expires_at
metadata
name
priority

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Expire billing credit grant

Description

Expires a billing credit grant immediately. Use when you need to terminate a credit grant before its natural expiration date.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Expire billing credit grant

Description

Expires a billing credit grant immediately. Use when you need to prevent an active credit grant from being used for future invoices.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void billing credit grant

Description

Voids a billing credit grant, preventing it from being used for future billing. Use when you need to permanently invalidate a credit grant. Once voided, the grant cannot be un-voided.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void billing credit grant

Description

Voids a billing credit grant, preventing it from being applied to future invoices. This operation is irreversible and marks the credit grant with a voided_at timestamp.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Billing Meter Event Adjustment

Description

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.

Action Parameters

cancel
event_name
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create billing meter event

Description

Creates a billing meter event to track usage for metered billing. Use when you need to record customer actions or usage that should be billed according to a billing meter configuration. Events are processed asynchronously and must have timestamps within the past 35 calendar days or up to 5 minutes in the future.

Action Parameters

event_name
stringRequired
identifier
payload
objectRequired
timestamp

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create billing meter

Description

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.

Action Parameters

customer_mapping
default_aggregation
objectRequired
display_name
stringRequired
event_name
stringRequired
event_time_window
value_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Billing Meter

Description

Tool to update a billing meter's display name. Use when you need to modify the name of an existing billing meter.

Action Parameters

display_name
expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Deactivate Billing Meter

Description

Deactivates a billing meter. Use when you need to stop a meter from accepting new events and prevent it from being attached to prices.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Reactivate Billing Meter

Description

Reactivates a deactivated billing meter. Use when you need to resume tracking usage after a meter has been deactivated.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Billing Portal Configuration

Description

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.

Action Parameters

business_profile
default_return_url
features
objectRequired
login_page
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Billing Portal Configuration

Description

Update a billing portal configuration. Use when you need to modify portal settings, business profile, or features.

Action Parameters

active
business_profile
configuration
stringRequired
default_return_url
features
login_page
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create charge (deprecated)

Description

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.

Action Parameters

amount
integerRequired
application_fee_amount
capture
currency
stringRequired
customer
description
metadata
on_behalf_of
radar_options
receipt_email
shipping
source
statement_descriptor
statement_descriptor_suffix
transfer_data
transfer_group

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Charge

Description

Updates a Stripe charge with the specified parameters; unspecified fields remain unchanged. Use when you need to modify charge details like customer association, description, fraud details, metadata, receipt email, shipping information, or transfer group.

Action Parameters

charge
stringRequired
customer
description
fraud_details
metadata
receipt_email
shipping
transfer_group

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Charge Dispute

Description

Tool to update metadata on a charge's dispute. Use when you need to attach structured information to a dispute for tracking or internal reference purposes.

Action Parameters

charge
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Refund Charge

Description

Refunds a previously created charge that has not yet been refunded. Use when you need to return funds to the customer's original payment card.

Action Parameters

amount
charge
stringRequired
instructions_email
metadata
payment_intent
reason
refund_application_fee
reverse_transfer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Charge Refund

Description

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

Action Parameters

amount
charge
stringRequired
instructions_email
metadata
payment_intent
reason
refund_application_fee
reverse_transfer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Charge Refund

Description

Tool to update a specified refund within a charge. Use when you need to modify the metadata of an existing refund.

Action Parameters

charge
stringRequired
metadata
refund
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Expire Checkout Session

Description

Tool to expire an active Stripe Checkout Session. Use when you need to prevent customers from completing an open checkout session.

Action Parameters

session_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Checkout Session

Description

Tool to update a Stripe Checkout Session dynamically. Use when you need to modify customer information, line items, or shipping options on an existing checkout session. Line item updates require retransmitting the entire array.

Action Parameters

collected_information
line_items
metadata
session
stringRequired
shipping_options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Expire Checkout Session

Description

Tool to expire a Checkout Session that is in open status. Use when you need to manually expire a session before its automatic 24-hour expiration.

Action Parameters

session
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void a credit note

Description

Marks a credit note as void. Use when you need to void a credit note and reverse its adjustments.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update customer

Description

Updates a Stripe customer by setting parameter values. Unspecified parameters remain unchanged. Use when you need to modify customer details like name, email, address, or metadata.

Action Parameters

address
balance
business_name
cash_balance
customer
stringRequired
default_source
description
email
individual_name
invoice_prefix
invoice_settings
metadata
name
next_invoice_sequence
phone
preferred_locales
shipping
source
tax
tax_exempt

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create customer bank account

Description

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.

Action Parameters

customer
stringRequired
metadata
source
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update customer bank account

Description

Updates a specified bank account for a given customer. Use when you need to modify account holder details or metadata for a customer's bank account.

Action Parameters

account_holder_name
account_holder_type
customer
stringRequired
id
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify customer bank account

Description

Verifies a customer's bank account using microdeposit amounts. Use when you need to confirm ownership of a bank account by validating the microdeposit amounts sent to it.

Action Parameters

amounts
customer
stringRequired
expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create card for customer

Description

Tool to create a new card payment source for an existing Stripe customer. Use when you need to add a credit or debit card to a customer's account for future payments.

Action Parameters

card
customer
stringRequired
metadata
source

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update customer card

Description

Tool to update a card for a specified customer. Use when you need to update card details including billing address, expiration, name, or metadata.

Action Parameters

address_city
address_country
address_line1
address_line2
address_state
address_zip
customer
stringRequired
exp_month
exp_year
id
stringRequired
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Customer Cash Balance Settings

Description

Updates a customer's cash balance settings to control how funds are applied to payment intents and invoices. Use when you need to change the reconciliation mode from automatic to manual or vice versa.

Action Parameters

customer
stringRequired
expand
settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer Funding Instructions

Description

Creates or retrieves funding instructions for a customer cash balance via bank transfer. Use when you need to provide bank account details for customers to fund their account.

Action Parameters

bank_transfer
objectRequired
currency
stringRequired
customer
stringRequired
funding_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create card or payment source

Description

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.

Action Parameters

customer
stringRequired
metadata
source
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify bank account source

Description

Tool to verify a customer's bank account by confirming microdeposit amounts. Use when a bank account needs verification after microdeposits have been sent.

Action Parameters

amounts
customer
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create customer subscription

Description

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

Action Parameters

add_invoice_items
application_fee_percent
automatic_tax
billing_cycle_anchor
billing_thresholds
cancel_at
cancel_at_period_end
collection_method
currency
customer
stringRequired
days_until_due
default_payment_method
default_tax_rates
description
discounts
expand
invoice_settings
items
metadata
off_session
on_behalf_of
payment_behavior
payment_settings
proration_behavior
transfer_data
trial_end
trial_period_days

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update customer subscription

Description

Tool to update a customer's subscription. Use when modifying subscription items, billing cycle, payment methods, or metadata for an existing subscription.

Action Parameters

automatic_tax
billing_cycle_anchor
cancel_at
cancel_at_period_end
collection_method
customer
stringRequired
default_payment_method
default_tax_rates
description
discounts
items
metadata
payment_behavior
proration_behavior
subscription_exposed_id
stringRequired
trial_end

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer Session

Description

Tool to create a Stripe Customer Session for front-end SDK access. Use when you need to grant Stripe.js or other front-end SDKs controlled access to specific customer resources.

Action Parameters

components
objectRequired
customer
customer_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify customer bank account

Description

Verifies a bank account for a customer using microdeposit amounts. Use when you need to confirm ownership of a bank account by providing the amounts of two microdeposits sent to the account.

Action Parameters

amounts
bank_account_id
stringRequired
customer_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Close Dispute

Description

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.

Action Parameters

dispute
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create entitlement feature

Description

Tool to create a feature for entitlements management. Use when you need to define a new feature that can be granted through entitlements.

Action Parameters

lookup_key
stringRequired
metadata
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update entitlements feature

Description

Tool to update a feature's properties or deactivate it. Use when you need to modify an existing entitlements feature's metadata, name, or active status.

Action Parameters

active
id
stringRequired
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create File Link

Description

Tool to create a shareable URL for an uploaded Stripe file with optional expiration. Use when you need to generate a public link for a file that has been uploaded to Stripe.

Action Parameters

expires_at
file
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update file link

Description

Tool to update an existing file link in Stripe. Use when you need to modify the expiration time or metadata of a file link. Note: Expired links cannot be updated.

Action Parameters

expires_at
link
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Financial Connections Session

Description

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.

Action Parameters

account_holder
objectRequired
filters
permissions
arrayRequired
prefetch
return_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create invoice item

Description

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

Action Parameters

amount
currency
customer
customer_account
description
discountable
discounts
invoice
metadata
period
price_data
pricing
quantity
subscription
tax_behavior
tax_code
tax_rates
unit_amount_decimal

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add line items to invoice

Description

Tool to bulk add line items to an existing draft invoice. Use when you need to add multiple line items to an invoice at once. The invoice must be in draft status. Each line item can reference an existing price or provide inline price data.

Action Parameters

invoice
stringRequired
lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach payment to invoice

Description

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.

Action Parameters

invoice
stringRequired
payment_intent
payment_record

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Finalize an invoice

Description

Finalizes a draft invoice. Use when you need to transition an invoice from draft status to finalized, making it ready for payment collection.

Action Parameters

auto_advance
expand
invoice
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Mark invoice as uncollectible

Description

Tool to mark a Stripe invoice as uncollectible for bad debt accounting purposes. Use when you need to write off an unpaid invoice that is unlikely to be collected.

Action Parameters

invoice
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Pay an invoice

Description

Tool to pay an invoice manually outside the normal collection schedule. Use when you need to manually trigger payment on an invoice or mark it as paid externally using paid_out_of_band parameter.

Action Parameters

forgive
invoice
stringRequired
mandate
off_session
paid_out_of_band
payment_method
source

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove invoice line items

Description

Tool to bulk remove line items from a draft Stripe invoice. Use when you need to remove multiple line items at once from an invoice that has not yet been finalized.

Action Parameters

invoice
stringRequired
invoice_metadata
lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bulk update invoice line items

Description

Tool to bulk update multiple line items on a draft invoice. Use when you need to modify descriptions, amounts, quantities, discounts, or other properties of existing line items on an invoice that is still in draft status. This operation only works with draft invoices; finalized invoices cannot be updated using this endpoint.

Action Parameters

invoice
stringRequired
invoice_metadata
lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void an invoice

Description

Voids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice while preserving audit history. Only finalized invoices can be voided.

Action Parameters

invoice
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payment Intent

Description

Updates a PaymentIntent without confirming it. Use when you need to modify payment amount, description, metadata, or other properties before confirmation.

Action Parameters

amount
application_fee_amount
capture_method
currency
customer
description
intent
stringRequired
metadata
payment_method
payment_method_configuration
receipt_email
setup_future_usage
shipping
statement_descriptor
statement_descriptor_suffix

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm payment intent

Description

Tool to confirm a PaymentIntent to finalize payment. Use when customer payment needs confirmation with current or new payment method. Upon confirmation, PaymentIntent attempts payment and transitions to requires_action (if authentication needed), requires_payment_method or canceled (if payment fails), succeeded or requires_capture (if successful).

Action Parameters

capture_method
confirmation_token
error_on_requires_action
intent
stringRequired
mandate
mandate_data
metadata
off_session
payment_method
payment_method_data
payment_method_options
radar_options
receipt_email
return_url
setup_future_usage
shipping
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Payment Link

Description

Tool to create a Stripe payment link for collecting payments from customers. Use when you need a shareable URL to accept payments without building a custom checkout flow.

Action Parameters

after_completion
allow_promotion_codes
application_fee_amount
application_fee_percent
automatic_tax
billing_address_collection
consent_collection
currency
custom_fields
custom_text
customer_creation
inactive_message
invoice_creation
line_items
arrayRequired
metadata
name_collection
on_behalf_of
optional_items
payment_intent_data
payment_method_collection
payment_method_types
phone_number_collection
restrictions
shipping_address_collection
shipping_options
submit_type
subscription_data
tax_id_collection
transfer_data

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create payment method configuration

Description

Creates a payment method configuration to control which payment methods are displayed during checkout. Use when setting up payment options for customers.

Action Parameters

acss_debit
affirm
afterpay_clearpay
alipay
alma
amazon_pay
apple_pay
apple_pay_later
au_becs_debit
bacs_debit
bancontact
billie
blik
boleto
card
cartes_bancaires
cashapp
crypto
customer_balance
eps
fpx
fr_meal_voucher_conecs
giropay
google_pay
grabpay
ideal
jcb
kakao_pay
klarna
konbini
kr_card
link
mb_way
mobilepay
multibanco
name
naver_pay
nz_bank_account
oxxo
p24
parent
pay_by_bank
payco
paynow
paypal
paypay
payto
pix
promptpay
revolut_pay
samsung_pay
satispay
sepa_debit
sofort
swish
twint
us_bank_account
wechat_pay
zip

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update payment method configuration

Description

Tool to update payment method configuration in Stripe. Use when you need to modify which payment methods are displayed to customers at checkout. Updates display preferences for various payment methods including cards, digital wallets, and regional payment options.

Action Parameters

acss_debit_display_preference
active
affirm_display_preference
afterpay_clearpay_display_preference
alipay_display_preference
alma_display_preference
amazon_pay_display_preference
apple_pay_display_preference
apple_pay_later_display_preference
au_becs_debit_display_preference
bacs_debit_display_preference
bancontact_display_preference
billie_display_preference
blik_display_preference
boleto_display_preference
card_display_preference
cartes_bancaires_display_preference
cashapp_display_preference
configuration
stringRequired
crypto_display_preference
customer_balance_display_preference
eps_display_preference
fpx_display_preference
giropay_display_preference
google_pay_display_preference
grabpay_display_preference
ideal_display_preference
jcb_display_preference
kakao_pay_display_preference
klarna_display_preference
konbini_display_preference
kr_card_display_preference
link_display_preference
mb_way_display_preference
mobilepay_display_preference
multibanco_display_preference
name
naver_pay_display_preference
nz_bank_account_display_preference
oxxo_display_preference
p24_display_preference
pay_by_bank_display_preference
payco_display_preference
paynow_display_preference
paypal_display_preference
paypay_display_preference
payto_display_preference
pix_display_preference
promptpay_display_preference
revolut_pay_display_preference
samsung_pay_display_preference
satispay_display_preference
sepa_debit_display_preference
sofort_display_preference
swish_display_preference
twint_display_preference
us_bank_account_display_preference
wechat_pay_display_preference
zip_display_preference

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create payment method

Description

Creates a PaymentMethod object to store payment details for transactions or future use. Use when you need to create a new payment method for a customer. Specify the payment method type and provide the corresponding payment method details.

Action Parameters

acss_debit
allow_redisplay
au_becs_debit
bacs_debit
billing_details
card
metadata
nz_bank_account
radar_options
sepa_debit
type
stringRequired
us_bank_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach payment method to customer

Description

Attaches a PaymentMethod to a Customer. Use when you need to save a payment method for future use with a specific customer. Either customer or customer_account must be provided.

Action Parameters

customer
customer_account
payment_method
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Detach payment method from customer

Description

Tool to detach a PaymentMethod from a Customer. Use when you need to remove a saved payment method from a customer account.

Action Parameters

payment_method
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment attempt canceled

Description

Tool to report that the most recent payment attempt for a Payment Record was canceled. Use when a customer or system cancels a payment attempt.

Action Parameters

canceled_at
integerRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment attempt informational

Description

Report informational updates on a Payment Record without changing its state. Use when updating customer details, description, metadata, or shipping information.

Action Parameters

customer_details
description
expand
id
stringRequired
metadata
shipping_details

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report Payment Record

Description

Tool to report a payment record in terminal state or for initialization. Use when you need to report payments that occurred on- or off-Stripe to create a unified payment history.

Action Parameters

amount_requested
objectRequired
customer_details
customer_presence
description
failed
guaranteed
initiated_at
integerRequired
metadata
outcome
payment_method_details
objectRequired
processor_details
objectRequired
shipping_details

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a plan

Description

Tool to create a recurring billing plan with flexible pricing configuration. Use when setting up subscription plans with defined pricing, currency, and billing intervals.

Action Parameters

active
amount
amount_decimal
billing_scheme
currency
stringRequired
id
interval
stringRequired
interval_count
metadata
meter
nickname
product
tiers
tiers_mode
transform_usage
trial_period_days
usage_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach feature to product

Description

Tool to attach an entitlement feature to a product. Use when you need to link features to products for customer entitlements. When a product with an attached feature is purchased, Stripe automatically creates an entitlement to that feature for the customer.

Action Parameters

entitlement_feature
stringRequired
expand
product
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Quote

Description

Tool to update an existing Stripe quote with new values. Use when modifying quote details like description, line items, metadata, or other quote parameters.

Action Parameters

application_fee_amount
application_fee_percent
automatic_tax
collection_method
customer
customer_account
default_tax_rates
description
discounts
expires_at
footer
header
invoice_settings
line_items
metadata
on_behalf_of
quote
stringRequired
subscription_data
transfer_data

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Accept quote

Description

Tool to accept a specified quote. Accepting a quote transitions it to 'accepted' status and creates an invoice, subscription, or subscription schedule depending on the quote configuration.

Action Parameters

quote
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel quote

Description

Cancels a Stripe quote. Use when a quote needs to be canceled before acceptance or expiration. Once canceled, the quote cannot be recovered or modified.

Action Parameters

quote_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Report Run

Description

Tool to create a new report run object and begin processing the report. Use when you need to generate financial or operational reports from Stripe data.

Action Parameters

parameters
report_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Setup Intent

Description

Creates a SetupIntent object to collect payment method permissions for future payments. Use when setting up payment methods for subscriptions or saving cards for later use.

Action Parameters

attach_to_self
automatic_payment_methods
confirm
confirmation_token
customer
customer_account
description
excluded_payment_method_types
flow_directions
mandate_data
metadata
on_behalf_of
payment_method
payment_method_configuration
payment_method_data
payment_method_options
payment_method_types
return_url
single_use
usage
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update setup intent

Description

Updates a SetupIntent object to modify configuration parameters and metadata. Use when you need to update an existing SetupIntent before completion.

Action Parameters

attach_to_self
customer
customer_account
description
flow_directions
intent
stringRequired
metadata
payment_method
payment_method_configuration
payment_method_types

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel SetupIntent

Description

Tool to cancel a SetupIntent object. Use when a SetupIntent in 'requires_payment_method', 'requires_confirmation', or 'requires_action' state needs to be abandoned.

Action Parameters

cancellation_reason
intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm SetupIntent

Description

Tool to confirm a SetupIntent to establish customer's payment method for future use. Use when customer completes payment method setup and you need to finalize the intent.

Action Parameters

confirmation_token
intent
stringRequired
mandate_data
payment_method
payment_method_data
payment_method_options
return_url
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Source

Description

Updates a Stripe source with specified parameters. Use when you need to modify source metadata, owner information, or mandate details.

Action Parameters

amount
mandate
metadata
owner
source
stringRequired
source_order

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create subscription item

Description

Tool to add a new item to an existing subscription. Use when adding pricing/products to an active subscription.

Action Parameters

billing_thresholds
discounts
metadata
payment_behavior
price
price_data
proration_behavior
proration_date
quantity
subscription
stringRequired
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update subscription item

Description

Tool to update a subscription item's plan, quantity, billing thresholds, discounts, or metadata. Use when you need to modify an existing subscription item. Changes may trigger prorations.

Action Parameters

billing_thresholds
discounts
item
stringRequired
metadata
off_session
payment_behavior
price
price_data
proration_behavior
proration_date
quantity
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create subscription schedule

Description

Tool to create a new subscription schedule for managing subscription changes over time. Use when you need to schedule future subscription modifications, phase transitions, or automate subscription lifecycle management.

Action Parameters

billing_mode
customer
customer_account
default_settings
end_behavior
from_subscription
metadata
phases
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Subscription Schedule

Description

Tool to update an existing subscription schedule in Stripe. Use when you need to modify phases, default settings, metadata, or end behavior of a subscription schedule.

Action Parameters

default_settings
end_behavior
metadata
phases
proration_behavior
schedule
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel subscription schedule

Description

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

Action Parameters

invoice_now
prorate
schedule
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Release subscription schedule

Description

Tool to release a subscription schedule. Use when you want to stop scheduling phases while leaving the existing subscription in place. The schedule must have status 'not_started' or 'active' to be released. After release, the subscription continues independently.

Action Parameters

preserve_cancel_date
schedule
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update subscription

Description

Tool to update an existing Stripe subscription with specified parameters. Use when you need to modify subscription items, billing settings, payment methods, or metadata for an active subscription.

Action Parameters

add_invoice_items
application_fee_percent
automatic_tax
billing_cycle_anchor
billing_thresholds
cancel_at
cancel_at_period_end
cancellation_details
collection_method
days_until_due
default_payment_method
default_source
default_tax_rates
description
discounts
invoice_settings
items
metadata
off_session
on_behalf_of
pause_collection
payment_behavior
payment_settings
pending_invoice_item_interval
proration_behavior
proration_date
subscription_exposed_id
stringRequired
transfer_data
trial_end
trial_from_plan
trial_settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Migrate subscription to flexible billing

Description

Migrate a subscription from classic to flexible billing mode. Use when upgrading billing mode to enable flexible proration and invoice calculation. Requires Stripe API version 2025-06-30.basil or later.

Action Parameters

billing_mode
objectRequired
subscription
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax Calculation

Description

Creates a Tax Calculation to compute taxes for customer purchases. Use when you need to calculate taxes for a transaction before finalizing it, such as displaying tax amounts in a shopping cart.

Action Parameters

currency
stringRequired
customer
customer_details
line_items
arrayRequired
ship_from_details
shipping_cost
tax_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax ID

Description

Creates a new tax ID for an account or customer. Use when you need to add tax identification for compliance and invoicing purposes.

Action Parameters

owner
type
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create tax rate

Description

Tool to create a new tax rate in Stripe for use in billing and checkout operations. Use when you need to define a new tax rate that can be applied to invoices, subscriptions, or Checkout Sessions.

Action Parameters

active
Defaults to True
country
description
display_name
stringRequired
inclusive
booleanRequired
jurisdiction
metadata
percentage
numberRequired
state
tax_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Tax Rate

Description

Tool to update an existing tax rate in Stripe. Use when you need to modify tax rate properties such as display_name, description, active status, or metadata.

Action Parameters

active
country
description
display_name
jurisdiction
metadata
state
tax_rate
stringRequired
tax_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax Registration

Description

Creates a new Tax Registration object to enable tax collection in specified jurisdictions. Use when setting up tax collection for a new country, state, or province.

Action Parameters

active_from
Required
country
stringRequired
country_options
objectRequired
expires_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Tax Registration

Description

Tool to update an existing tax registration in Stripe. Use when you need to modify the active_from or expires_at fields of a registration. Registrations cannot be deleted after creation; use expires_at to terminate them instead.

Action Parameters

active_from
expires_at
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Tax Settings

Description

Updates Stripe Tax Settings parameters used in tax calculations. Use to configure default tax behavior, tax codes, and business head office location for tax purposes.

Action Parameters

defaults
head_office

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax Transaction from Calculation

Description

Tool to create a Tax Transaction from a calculation before 90-day expiration. Use when you need to finalize tax calculations and create a permanent transaction record.

Action Parameters

calculation
stringRequired
metadata
posted_at
reference
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create tax transaction reversal

Description

Tool to create a reversal transaction for a previously created tax transaction. Use when you need to reverse a transaction fully or partially (specific line items, shipping costs, or flat amounts). All reversal amounts must be negative.

Action Parameters

flat_amount
line_items
metadata
mode
stringRequired
original_transaction
stringRequired
reference
stringRequired
shipping_cost

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax Transaction Reversal

Description

Tool to partially or fully reverse a previously created Tax Transaction for refund scenarios. Use when processing customer refunds that require tax adjustments.

Action Parameters

flat_amount
line_items
metadata
mode
stringRequired
original_transaction
stringRequired
reference
stringRequired
shipping_cost

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax Transaction from Calculation

Description

Creates a Tax Transaction from a valid tax calculation. Use when you need to record a tax transaction based on a previously calculated tax assessment. The calculation must be valid and not expired (expires after 90 days).

Action Parameters

calculation
stringRequired
metadata
posted_at
reference
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Terminal Configuration

Description

Creates a new Configuration object for Stripe payment terminals with customizable settings. Use when setting up terminal readers with specific device configurations, offline settings, tipping options, or WiFi credentials.

Action Parameters

bbpos_wisepad3
bbpos_wisepos_e
name
offline
reader_security
reboot_window
stripe_s700
tipping
verifone_p400
wifi

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Terminal Configuration

Description

Tool to update a Stripe Terminal Configuration. Use when you need to modify terminal reader settings including device-specific configurations, offline transaction capabilities, security settings, reboot windows, WiFi credentials, or tipping configurations. Changes can take up to 10 minutes to reflect on target readers.

Action Parameters

bbpos_wisepad3
bbpos_wisepos_e
configuration
stringRequired
name
offline
reader_security
reboot_window
stripe_s700
tipping
verifone_p400
wifi

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Terminal Connection Token

Description

Creates a short-lived connection token for Stripe Terminal SDK to connect to readers. Use when initializing a Terminal connection with the Stripe Terminal SDK.

Action Parameters

location

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Terminal Location

Description

Tool to create a new Terminal location in Stripe for fleet management. Use when you need to register a physical location where Terminal readers will be deployed.

Action Parameters

address
objectRequired
address_kana
address_kanji
configuration_overrides
display_name
stringRequired
display_name_kana
display_name_kanji
metadata
phone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Terminal Location

Description

Updates a Terminal Location by modifying specified parameters. Use when you need to change location details like display name, address, phone, or metadata.

Action Parameters

address
address_kana
address_kanji
configuration_overrides
display_name
display_name_kana
display_name_kanji
location
stringRequired
metadata
phone

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Terminal Reader Action

Description

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.

Action Parameters

reader_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set Terminal Reader Display

Description

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.

Action Parameters

inputs
arrayRequired
metadata
reader_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm PaymentIntent on Terminal Reader

Description

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.

Action Parameters

confirm_config
payment_intent
stringRequired
reader_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Process Payment Intent on Terminal Reader

Description

Tool to initiate a payment flow on a Terminal Reader to process a PaymentIntent. Use when you need to process card payments through Stripe Terminal readers.

Action Parameters

payment_intent
stringRequired
process_config
reader_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Terminal Reader

Description

Tool to update a Terminal Reader object by setting parameter values. Use when you need to modify the label or metadata of an existing reader device.

Action Parameters

label
metadata
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Terminal Reader Action

Description

Cancel the current action on a Stripe Terminal reader device. Use when you need to stop an in-progress reader action such as payment collection or card reading.

Action Parameters

reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Collect Inputs on Terminal Reader

Description

Tool to initiate input collection on a Terminal Reader to display forms and gather customer information. Use when you need to collect signatures, emails, phone numbers, or other data from customers at point-of-sale.

Action Parameters

inputs
arrayRequired
metadata
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Collect payment method on Terminal Reader

Description

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.

Action Parameters

collect_config
payment_intent
stringRequired
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm PaymentIntent on Terminal Reader

Description

Tool to confirm a PaymentIntent on a Terminal Reader device. Use when finalizing a payment on a reader after the payment method has been collected.

Action Parameters

confirm_config
payment_intent
stringRequired
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Process payment on terminal reader

Description

Initiates a payment flow on a Stripe Terminal Reader to process a PaymentIntent. Use when you need to hand off a PaymentIntent to a physical card reader for customer payment. The reader must be online and not currently processing another action, and the PaymentIntent must be in requires_capture or requires_payment_method state. The response returns immediately with action status 'in_progress'; poll the Reader object or use webhooks to determine completion.

Action Parameters

payment_intent
stringRequired
process_config
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Process SetupIntent on Terminal Reader

Description

Tool to hand off a SetupIntent to a Terminal Reader for processing. Use when you need to save payment method details without charging the customer immediately.

Action Parameters

allow_redisplay
customer_consent_collected
booleanRequired
process_config
reader
stringRequired
setup_intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set Reader Display

Description

Configures a Stripe terminal reader to display cart information on screen. Use when you need to show customers their purchase details on a physical terminal device during checkout. Supported on Verifone P400, BBPOS WisePOS E, and Stripe Reader S700.

Action Parameters

cart
objectRequired
reader
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set Terminal Reader Display

Description

Tool to configure a terminal reader's display to show cart details. Use when you need to display line items, amounts, and currency information on a Stripe Terminal reader screen.

Action Parameters

cart
objectRequired
reader_id
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create test confirmation token

Description

Tool to create a test mode Confirmation Token for integration tests. Use when testing payment flows without processing real payments.

Action Parameters

payment_method
payment_method_data
payment_method_options
return_url
setup_future_usage
shipping

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Fund Test Mode Cash Balance

Description

Tool to fund a test mode customer's cash balance by creating an incoming test mode bank transfer. Use when testing cash balance functionality in Stripe test mode.

Action Parameters

amount
integerRequired
currency
stringRequired
customer
stringRequired
reference

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Fund test mode cash balance

Description

Tool to fund a test mode customer's cash balance by simulating an incoming bank transfer. Use when testing cash balance functionality in Stripe test mode.

Action Parameters

amount
integerRequired
currency
stringRequired
customer_id
stringRequired
reference

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Present payment method to test reader

Description

Tool to simulate presenting a payment method to a terminal reader for testing. Use when testing payment workflows without physical hardware.

Action Parameters

amount_tip
card
card_present
interac_present
reader
stringRequired
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Simulate successful input collection

Description

Tool to simulate a successful input collection on a simulated terminal reader. Use when testing terminal reader input collection scenarios in test mode.

Action Parameters

expand
reader
stringRequired
skip_non_required_inputs

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Simulate Terminal Reader Timeout

Description

Tool to simulate an input collection timeout on a Stripe Terminal reader. Use when testing timeout scenarios without physical hardware.

Action Parameters

expand
reader
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Test Clock

Description

Tool to create a test clock for testing time-based scenarios in Stripe. Use when you need to simulate the passage of time for testing subscriptions, trials, or other time-dependent features.

Action Parameters

frozen_time
integerRequired
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Advance test clock

Description

Tool to advance a test clock to a future timestamp. Use when testing time-based billing scenarios in sandbox environments.

Action Parameters

clock_id
stringRequired
frozen_time
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Advance Test Clock

Description

Tool to advance a test clock to a specified future time in Stripe. Use when testing time-dependent functionality like subscriptions or trials.

Action Parameters

frozen_time
integerRequired
test_clock
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create CVC update token

Description

Tool to create a single-use CVC update token for card re-collection. Use when you need to collect an updated CVC value for a saved card, typically during payment confirmation with manual confirmation_method on a PaymentIntent.

Action Parameters

cvc_update
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Account Capability

Description

Updates an existing account capability for a Stripe connected account. Use when you need to request a new capability or remove a non-permanent capability. There may be a delay before the requested capability becomes active, and the response includes any activation requirements.

Action Parameters

account
stringRequired
capability
stringRequired
experimental
requested

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update balance settings overview

Description

Tool to update balance settings for a Stripe account. Use when customizing payout schedules, settlement timing, or negative balance handling for a connected account.

Action Parameters

payments
stripe_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create credit grant

Description

Tool to create a credit grant that allocates billing credits to a customer. Use when you need to provide promotional credits, loyalty rewards, or paid credit allocations.

Action Parameters

amount
objectRequired
applicability_config
objectRequired
category
customer
customer_account
effective_at
expires_at
metadata
name
priority

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create billing meter event

Description

Creates a billing meter event for usage-based billing. Use when you need to record customer usage that should be metered and billed according to a configured billing meter.

Action Parameters

event_name
stringRequired
identifier
payload
objectRequired
timestamp

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Billing Portal Configuration

Description

Tool to update an existing billing portal configuration in Stripe. Use when you need to modify portal settings like business profile, features, or default return URL.

Action Parameters

active
business_profile
configuration_id
stringRequired
default_return_url
features
login_page
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Billing Portal Configuration

Description

Tool to create a billing portal configuration for Stripe. Use when you need to configure the functionality and behavior of a customer portal session.

Action Parameters

business_profile
default_return_url
features
objectRequired
login_page
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Billing Portal Session

Description

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

Action Parameters

configuration
customer
customer_account
flow_data
locale
on_behalf_of
return_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update and retrieve Checkout Session

Description

Tool to update and retrieve a Checkout Session object from Stripe. Use when you need to update metadata or other fields while retrieving the session details.

Action Parameters

expand
id
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Credit Note

Description

Tool to update an existing credit note in Stripe by modifying its memo or metadata. Use when you need to add context or store additional information on an already-issued credit note.

Action Parameters

credit_note_id
stringRequired
memo
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Customer Balance Transaction

Description

Creates an immutable transaction that updates the customer's credit balance. Use when you need to manually adjust a customer's account balance for credits or debits.

Action Parameters

amount
integerRequired
currency
stringRequired
customer_id
stringRequired
description
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Fund Test Mode Cash Balance

Description

Funds a test mode cash balance by creating funding instructions for test customer. Use in test mode to simulate bank transfers and fund customer cash balances for testing purposes.

Action Parameters

bank_transfer
objectRequired
currency
stringRequired
customer_id
stringRequired
funding_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Stripe customers

Description

Tool to search for Stripe customers using a search query. Use when you need to find customers by email, name, metadata, or other fields using Stripe's Search Query Language.

Action Parameters

limit
page
query
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
next_page
object
stringRequired
successful
booleanRequired
total_count
url
stringRequired

Tool Name: Attach source to customer

Description

Tool to attach a Source object to a Customer. Use when you need to save a payment source for future charges. Note: The Sources API is deprecated; consider using PaymentMethods API for new integrations.

Action Parameters

customer_id
stringRequired
metadata
source
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update customer bank account

Description

Updates a bank account source attached to a customer. Use when you need to modify editable attributes like account holder name, type, or metadata.

Action Parameters

account_holder_name
account_holder_type
customer_id
stringRequired
metadata
source_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a file link

Description

Tool to create a file link in Stripe. Use when you need to generate a shareable link to access an uploaded file.

Action Parameters

expires_at
file
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update File Link

Description

Tool to update an existing file link in Stripe. Use when you need to modify the expiration time or metadata of a file link. Note: Expired links cannot be updated.

Action Parameters

expires_at
id
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Financial Connections Session

Description

Tool to create a Financial Connections Session to launch the authorization flow for linking financial accounts. The session generates credentials to authenticate the Stripe.js authorization process.

Action Parameters

account_holder
objectRequired
filters
permissions
arrayRequired
prefetch
return_url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create FX Quote

Description

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.

Action Parameters

from_currencies
arrayRequired
lock_duration
to_currency
stringRequired
usage_payment_destination
usage_payment_on_behalf_of
usage_transfer_destination
usage_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void an invoice

Description

Voids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice that has not been paid. Once voided, the invoice cannot be undone and maintains audit history.

Action Parameters

invoice_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Invoice Line Item

Description

Updates an invoice's line item before finalization. Use when you need to modify details of a line item such as description, metadata, amount, or tax settings before the invoice is finalized.

Action Parameters

amount
description
discountable
discounts
invoice
stringRequired
line_item_id
stringRequired
metadata
period
price_data
pricing
quantity
tax_amounts
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove lines from invoice

Description

Tool to remove multiple line items from a draft Stripe invoice. Use when you need to delete or unassign specific line items from an invoice that hasn't been finalized yet.

Action Parameters

invoice_id
stringRequired
invoice_metadata
lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void invoice

Description

Tool to void a finalized Stripe invoice. Use when you need to permanently void an invoice while preserving an audit trail. This operation cannot be undone and only works on finalized invoices.

Action Parameters

invoice_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update invoice line items

Description

Tool to update multiple line items on a draft invoice in Stripe. Use when you need to modify line item attributes such as description, quantity, amount, pricing, discounts, taxes, or metadata on an existing draft invoice.

Action Parameters

invoice_id
stringRequired
invoice_metadata
lines
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void an invoice

Description

Tool to permanently void a finalized Stripe invoice. Use when an invoice needs to be canceled while maintaining an audit trail. This operation is irreversible and only applies to finalized invoices.

Action Parameters

invoice_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payment Link

Description

Updates a payment link with new configuration parameters. Use when modifying payment link settings such as metadata, active status, or payment collection options.

Action Parameters

active
allow_promotion_codes
billing_address_collection
customer_creation
id
stringRequired
inactive_message
metadata
payment_method_collection
payment_method_types
submit_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update payment method configuration

Description

Updates a payment method configuration to control which payment methods are displayed at checkout. Use when modifying payment method availability or display settings.

Action Parameters

acss_debit
active
affirm
afterpay_clearpay
alipay
alma
amazon_pay
apple_pay
apple_pay_later
au_becs_debit
bacs_debit
bancontact
billie
blik
boleto
card
cartes_bancaires
cashapp
customer_balance
eps
fpx
giropay
google_pay
grabpay
id
stringRequired
ideal
jcb
kakao_pay
klarna
konbini
kr_card
link
mb_way
mobilepay
multibanco
name
naver_pay
oxxo
p24
pay_by_bank
payco
paynow
paypal
paypay
payto
pix
promptpay
revolut_pay
samsung_pay
satispay
sepa_debit
sofort
swish
twint
us_bank_account
wechat_pay
zip

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Payment Method Domain

Description

Tool to create a payment method domain in Stripe. Use when you need to register a web domain to control payment method visibility in Elements.

Action Parameters

domain_name
stringRequired
enabled

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payment Method Domain

Description

Updates an existing payment method domain to enable or disable it. Use when you need to control whether payment methods requiring domain verification will appear in Elements or Embedded Checkout.

Action Parameters

enabled
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach payment method

Description

Attaches a PaymentMethod to a Customer for future payment processing. Use when you need to save a payment method for future use with a specific customer.

Action Parameters

customer
customer_account
payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Detach payment method

Description

Detaches a PaymentMethod from a Customer. Use when you need to remove a saved payment method from a customer account, making it unusable for future charges.

Action Parameters

payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report Payment Attempt

Description

Tool to report a payment attempt on a Stripe Payment Record. Use when updating a Payment Record with payment attempt details such as initiation time and outcome status.

Action Parameters

guaranteed
initiated_at
integerRequired
outcome
stringRequired
payment_record_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report Payment Attempt Canceled

Description

Tool to report that the most recent payment attempt was canceled. Use when you need to update a Payment Record to reflect a canceled payment attempt.

Action Parameters

canceled_at
integerRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment attempt guaranteed overview

Description

Reports that a payment attempt was guaranteed for a specific Payment Record. Use when confirming that a payment has been successfully guaranteed by the payment processor at a specific timestamp.

Action Parameters

guaranteed_at
integerRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment attempt information

Description

Tool to report additional payment attempt information for a payment record. Use when you need to add informational details about a payment attempt.

Action Parameters

description
stringRequired
payment_record_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report Payment Record Refund

Description

Reports that the most recent payment attempt on a Payment Record was refunded. Use when you need to record a refund for a successfully processed payment to maintain accurate payment records. Multiple partial refunds can be reported until the full amount is refunded.

Action Parameters

amount
id
stringRequired
initiated_at
metadata
outcome
stringRequired
processor_details
objectRequired
refunded
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update and retrieve payout

Description

Tool to update and retrieve a payout. Use when you need to update metadata or other payout details.

Action Parameters

metadata
payout_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Plan Overview

Description

Tool to update a Stripe plan by setting passed parameter values. Use when modifying plan details like nickname, metadata, or active status.

Action Parameters

active
id
stringRequired
metadata
nickname
product
trial_period_days

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a price

Description

Tool to create a new Stripe price for a product. Use when defining pricing for one-time or recurring charges.

Action Parameters

active
billing_scheme
currency
stringRequired
currency_options
custom_unit_amount
lookup_key
metadata
nickname
product
product_data
recurring
tax_behavior
tiers
tiers_mode
transfer_lookup_key
transform_quantity
unit_amount
unit_amount_decimal

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach feature to product

Description

Tool to attach an entitlement feature to a product. Use when you need to link features to products for customer entitlements.

Action Parameters

entitlement_feature
stringRequired
expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Promotion Code

Description

Creates a customer-redeemable promotion code for an underlying coupon. Use when you need to generate codes that customers can apply to receive discounts.

Action Parameters

active
code
customer
customer_account
expires_at
max_redemptions
metadata
promotion
objectRequired
restrictions

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a refund

Description

Tool to retrieve a specific Stripe refund by its ID. Use when you need to get detailed information about an existing refund.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel SetupIntent

Description

Tool to cancel a SetupIntent object. Use when a SetupIntent in cancelable state needs to be abandoned.

Action Parameters

cancellation_reason
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Confirm a SetupIntent

Description

Tool to confirm a SetupIntent to complete customer payment method setup. Use when you need to finalize saving a payment method for future use after creating a SetupIntent.

Action Parameters

confirmation_token
id
stringRequired
payment_method
return_url
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create SetupIntent

Description

Creates a SetupIntent to guide setting up and saving customer payment credentials for future payments. Use when you need to collect payment method information without immediately charging the customer.

Action Parameters

attach_to_self
automatic_payment_methods
confirm
confirmation_token
customer
customer_account
description
excluded_payment_method_types
flow_directions
mandate_data
metadata
on_behalf_of
payment_method
payment_method_configuration
payment_method_data
payment_method_options
payment_method_types
return_url
single_use
usage
use_stripe_sdk

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Shipping Rate

Description

Tool to update an existing Stripe shipping rate. Use when you need to modify shipping rate properties such as active status, fixed amounts, metadata, or tax behavior.

Action Parameters

active
fixed_amount
id
stringRequired
metadata
tax_behavior

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create subscription item

Description

Tool to add a new item to an existing subscription. Use when adding additional products or services to a customer's subscription without changing existing items.

Action Parameters

billing_thresholds
discounts
metadata
payment_behavior
price
price_data
proration_behavior
proration_date
quantity
subscription
stringRequired
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel subscription schedule

Description

Cancels a subscription schedule and its associated subscription immediately. Use when you need to stop scheduling of phases while leaving any existing subscription in place.

Action Parameters

invoice_now
prorate
schedule_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create subscription schedule

Description

Tool to create subscription schedules for managing subscriptions across multiple phases. Use when you need to set up a subscription with predefined phase transitions, trials, or future billing changes.

Action Parameters

customer
end_behavior
Defaults to release
from_subscription
metadata
phases
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update subscription schedule

Description

Tool to update an existing subscription schedule with new phases, settings, metadata, and end behavior. Use when modifying subscription schedule configuration.

Action Parameters

default_settings
end_behavior
id
stringRequired
metadata
phases
proration_behavior

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Release subscription schedule

Description

Tool to release a subscription schedule. Releases a subscription schedule immediately, stops scheduling future phases but leaves the existing subscription in place.

Action Parameters

preserve_cancel_date
schedule_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update subscription metadata

Description

Tool to update an existing Stripe subscription's properties such as metadata, description, payment method, and billing settings. Use when you need to modify subscription details without changing the subscription items or pricing.

Action Parameters

cancel_at_period_end
collection_method
default_payment_method
description
metadata
proration_behavior
subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Migrate subscription to flexible billing

Description

Tool to migrate a Stripe subscription from classic to flexible billing mode. Use when you need to upgrade a subscription to gain more control over proration calculations and invoice orchestration. This is a one-way migration that cannot be reverted.

Action Parameters

billing_mode
objectRequired
subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Tax ID

Description

Creates a new account or customer tax_id object. Use when you need to add tax identification information to a customer or account for invoices and credit notes.

Action Parameters

owner
type
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Tax Rate

Description

Tool to update an existing Stripe tax rate. Use when you need to modify tax rate properties such as display name, description, or active status.

Action Parameters

active
country
description
display_name
jurisdiction
metadata
state
tax_rate_id
stringRequired
tax_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Terminal Configuration

Description

Updates a Configuration object for terminal readers with device-specific settings. Use when modifying splash screens, tipping settings, offline mode, or reboot windows.

Action Parameters

bbpos_wisepad3
bbpos_wisepos_e
id
stringRequired
offline
reboot_window
stripe_s700
tipping
verifone_p400

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Terminal Connection Token

Description

Creates a short-lived connection token for Stripe Terminal SDK to connect to readers. Use when initializing Terminal SDK to establish secure reader connectivity.

Action Parameters

location

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create test Confirmation Token

Description

Tool to create a test mode Confirmation Token server-side for integration testing. Use when testing payment flows without using actual payment methods.

Action Parameters

payment_method
payment_method_data
payment_method_options
return_url
setup_future_usage
shipping

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a test clock

Description

Permanently deletes a test clock from Stripe. Use when you need to remove test clocks used for testing time-based features.

Action Parameters

test_clock
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Meter Event Adjustment

Description

Creates a billing meter event adjustment to cancel a previously sent meter event. Use when you need to cancel a meter event within 24 hours of Stripe receiving it.

Action Parameters

cancel
objectRequired
event_name
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Billing Meter Event Session

Description

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.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Present payment method on reader

Description

Tool to present a payment method on a simulated terminal reader for testing purposes. Use when testing payment flows, simulating card acceptance, or validating terminal reader integrations in test mode.

Action Parameters

amount_tip
card
card_present
interac_present
reader_id
stringRequired
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Process setup intent on terminal reader

Description

Initiates a SetupIntent flow on a Stripe Terminal Reader to save payment details. Use when you need to collect and save payment method information for future use.

Action Parameters

allow_redisplay
customer_consent_collected
booleanRequired
process_config
reader_id
stringRequired
setup_intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment attempt

Description

Tool to report a new payment attempt on a Payment Record. Use when adding a fresh payment attempt after all existing attempts have been canceled or failed.

Action Parameters

description
failed
guaranteed
id
stringRequired
initiated_at
integerRequired
metadata
outcome
payment_method_details
shipping_details

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report Payment Attempt Failed

Description

Reports that a recent payment attempt on a Payment Record has failed. Use when a payment attempt encounters an error to ensure Stripe has a complete view of payment flows.

Action Parameters

failed_at
integerRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment attempt guaranteed

Description

Reports that the most recent payment attempt on the specified Payment Record was guaranteed. Use when confirming that a payment has been successfully guaranteed by the payment processor at a specific timestamp.

Action Parameters

guaranteed_at
integerRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Report payment record refund

Description

Report that the most recent payment attempt on a Payment Record was refunded. Use when reporting refunds for off-Stripe payments to maintain accurate records.

Action Parameters

amount
id
stringRequired
initiated_at
metadata
outcome
stringRequired
processor_details
objectRequired
refunded
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Resume subscription

Description

Resumes a paused Stripe subscription with billing cycle and proration options. Use when a customer wants to restart payment collection on a previously paused subscription.

Action Parameters

billing_cycle_anchor
proration_behavior
proration_date
subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Upcoming Invoice

Description

Tool to preview the upcoming invoice for a customer, showing all pending charges including subscription renewals and invoice items. Use when you need to preview invoice amounts before they are finalized, test the effects of subscription updates including prorations, or estimate future billing.

Action Parameters

automatic_tax
coupon
currency
customer
customer_details
discounts
invoice_items
issuer
on_behalf_of
preview_mode
schedule
schedule_details
subscription
subscription_billing_cycle_anchor
subscription_cancel_at
subscription_cancel_at_period_end
subscription_cancel_now
subscription_default_tax_rates
subscription_details
subscription_items
subscription_proration_behavior
subscription_proration_date
subscription_resume_at
subscription_start_date
subscription_trial_end
subscription_trial_from_plan

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Balance

Description

Retrieves the complete current balance details for the connected Stripe account.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Bank Account

Description

Retrieves details of a specific bank account payment method on a Customer object. Use when you need to view bank account information for a customer.

Action Parameters

bank_account_id
stringRequired
customer_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Charge Details

Description

Retrieves full details for an existing Stripe charge using its unique ID.

Action Parameters

charge_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Checkout Session

Description

Tool to retrieve a Checkout Session object from Stripe. Use when you need to check the current state of a checkout session, including payment status and line items.

Action Parameters

expand
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Coupon Details

Description

Retrieves full details for an existing Stripe coupon using its unique ID. Use when you need to check coupon validity, discount details, or redemption limits.

Action Parameters

coupon_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve customer

Description

Retrieves detailed information for an existing Stripe customer using their unique customer ID.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve customer payment method

Description

Retrieves a specific PaymentMethod object for a given Customer. Use when you need to get detailed information about a customer's saved payment method.

Action Parameters

customer_id
stringRequired
payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve mandate

Description

Tool to retrieve a Stripe mandate by ID. Use when you need to get authorization details for recurring or single-use payments.

Action Parameters

expand
mandate_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve payment intent

Description

Retrieves a PaymentIntent by its ID; `client_secret` is required if a publishable API key is used.

Action Parameters

client_secret
payment_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve payment method

Description

Retrieves a PaymentMethod by its ID. Use when you need to view details about a stored payment instrument.

Action Parameters

payment_method_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a payout

Description

Tool to retrieve details of an existing Stripe payout. Use when you need to get information about a specific payout by its ID.

Action Parameters

payout_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Promotion Code

Description

Tool to retrieve a Stripe promotion code by its ID. Use when you need to get details about a specific promotion code including its associated coupon, usage restrictions, and redemption statistics.

Action Parameters

promotion_code_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve a refund

Description

Retrieves details for an existing Stripe refund using its unique `refund_id`.

Action Parameters

refund_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Report Run

Description

Tool to retrieve the details of an existing Stripe Report Run. Use when you need to check the status or results of a previously created report run.

Action Parameters

report_run_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve setup intent

Description

Retrieves details of a SetupIntent by its ID; `client_secret` is required if a publishable API key is used.

Action Parameters

client_secret
setup_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Shipping Rate

Description

Tool to retrieve details of a specific Stripe shipping rate by its unique ID. Use when you need to fetch information about a particular shipping rate.

Action Parameters

shipping_rate_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve subscription

Description

Retrieves detailed information for an existing Stripe subscription using its unique ID.

Action Parameters

subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve subscription item

Description

Retrieves detailed information for a specific subscription item using its unique ID. Use when you need to fetch subscription item details, pricing, or billing information.

Action Parameters

subscription_item_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Upcoming Invoice Line Items

Description

Tool to retrieve a paginated list of line items for an upcoming invoice preview. Use when you need to see detailed line items before an invoice is finalized.

Action Parameters

automatic_tax
coupon
currency
customer
discounts
ending_before
invoice_items
limit
preview_mode
schedule
starting_after
subscription

Action Response

data
arrayRequired
error
has_more
booleanRequired
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Search Stripe customers

Description

Retrieves a list of Stripe customers matching a search query that adheres to Stripe's Search Query Language.

Action Parameters

limit
page
query
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
next_page
object
stringRequired
successful
booleanRequired
total_count
url
stringRequired

Tool Name: Search invoices

Description

Searches for invoices using Stripe's Search Query Language. Use when you need to find invoices by status, amount, customer, currency, or other criteria. Data is typically searchable within one minute, though propagation can lag up to an hour during outages.

Action Parameters

limit
page
query
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
next_page
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Search payment intents

Description

Searches for PaymentIntents using Stripe's Search Query Language. Use when you need to find payments by status, amount, customer, or other criteria.

Action Parameters

limit
page
query
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
next_page
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Search Stripe products

Description

Tool to search for products using Stripe's Search Query Language. Use when you need to find products based on specific criteria like active status, name, or metadata.

Action Parameters

limit
page
query
stringRequired

Action Response

data
arrayRequired
error
has_more
booleanRequired
next_page
object
stringRequired
successful
booleanRequired
url
stringRequired

Tool Name: Send invoice for manual payment

Description

Tool to manually send a finalized Stripe invoice to the customer outside the automatic billing schedule. Use when you need to deliver an invoice for manual payment. Note: In test mode, no emails are sent, but webhook events (invoice.sent) are still generated.

Action Parameters

invoice
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set Reader Display

Description

Tool to set terminal reader display to show cart information to customers. Use when you need to display line items, taxes, and total amounts on a Stripe Terminal reader.

Action Parameters

cart
objectRequired
reader_id
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set terminal reader display

Description

Tool to set the display on a Stripe Terminal reader to show cart details. Use when you need to display line items, totals, and tax information on a physical terminal reader screen.

Action Parameters

cart
reader_id
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update billing credit grant

Description

Updates an existing billing credit grant. Use when you need to modify the expiration time or metadata of a credit grant.

Action Parameters

expires_at
id
stringRequired
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Cash Balance Settings

Description

Tool to update a customer's cash balance settings in Stripe. Use when you need to modify how funds transferred to a customer's cash balance are applied to payment intents and invoices.

Action Parameters

customer_id
stringRequired
settings

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Charge

Description

Tool to update a Stripe charge object with provided parameters. Use when you need to modify charge details such as description, metadata, fraud assessment, receipt email, shipping information, or transfer group.

Action Parameters

charge_id
stringRequired
customer
description
fraud_details
metadata
receipt_email
shipping
transfer_group

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Coupon

Description

Updates the metadata of a Stripe coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable. Use when you need to modify coupon metadata, name, or currency-specific options.

Action Parameters

coupon
stringRequired
currency_options
metadata
name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Credit Note

Description

Tool to update an existing credit note in Stripe. Use when you need to modify the memo or metadata fields of a credit note.

Action Parameters

id
stringRequired
memo
metadata

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Customer

Description

Updates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged.

Action Parameters

address
balance
coupon
customer_id
stringRequired
default_payment_method
default_source
description
email
invoice_settings
metadata
name
phone
shipping
tax
tax_exempt

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Customer Balance Transaction

Description

Updates a customer credit balance transaction. Only description and metadata can be modified after creation. Use when you need to update the description or add/modify metadata on an existing customer balance transaction.

Action Parameters

customer
stringRequired
description
metadata
transaction
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update customer source

Description

Update a specified source for a given customer. Use when modifying card details, bank account information, or source metadata.

Action Parameters

account_holder_name
account_holder_type
address_city
address_country
address_line1
address_line2
address_state
address_zip
customer
stringRequired
exp_month
exp_year
expand
id
stringRequired
metadata
name
owner

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Dispute

Description

Tool to update a Stripe dispute by submitting evidence or updating metadata. Use when responding to payment disputes to provide documentation countering the dispute claim.

Action Parameters

dispute
stringRequired
evidence
metadata
submit

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Invoice

Description

Updates a draft Stripe invoice. Use when modifying invoice details before finalization. Once finalized, monetary values and collection_method become immutable.

Action Parameters

account_tax_ids
application_fee_amount
auto_advance
automatic_tax
automatically_finalizes_at
collection_method
custom_fields
days_until_due
default_payment_method
default_source
default_tax_rates
description
discounts
due_date
effective_at
footer
invoice
stringRequired
issuer
metadata
number
on_behalf_of
payment_settings
rendering
shipping_cost
shipping_details
statement_descriptor
transfer_data

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update invoice item

Description

Updates an invoice item on a draft invoice. Use when modifying invoice item properties like amount, description, discounts, or tax settings before invoice finalization.

Action Parameters

amount
description
discountable
discounts
invoiceitem_id
stringRequired
metadata
period
price_data
pricing
quantity
tax_behavior
tax_code
tax_rates
unit_amount_decimal

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Invoice Item

Description

Updates an invoice item on an upcoming invoice. Use when modifying amount, description, or other properties of existing invoice line items before invoice is closed.

Action Parameters

amount
description
discountable
discounts
invoice_item_id
stringRequired
metadata
period
price
price_data
quantity
tax_behavior
tax_code
tax_rates
unit_amount_decimal

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Invoice Line Item

Description

Updates an invoice's line item. Use when you need to modify details of a line item before the invoice is finalized. This operation is only possible before the invoice is finalized.

Action Parameters

amount
description
discountable
discounts
invoice
stringRequired
line_item_id
stringRequired
metadata
period
price_data
pricing
quantity
tax_amounts
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payment Intent

Description

Updates a Stripe PaymentIntent with new values for specified parameters; note that if `currency` is updated, `amount` might also be required, and certain updates (e.g., to `payment_method`) can necessitate re-confirmation by the customer.

Action Parameters

amount
currency
customer
description
metadata
payment_intent_id
stringRequired
payment_method
receipt_email
setup_future_usage
shipping
statement_descriptor
statement_descriptor_suffix

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payment Method

Description

Updates an existing PaymentMethod object in Stripe. Use when you need to modify billing details, expiration dates, or metadata for a payment method. The payment method must be attached to a customer before updates can be applied.

Action Parameters

allow_redisplay
billing_details
card
metadata
payment_method_id
stringRequired
payto
us_bank_account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payment Method Domain

Description

Updates an existing payment method domain configuration. Use when you need to enable or disable a registered payment method domain that controls where payment methods are shown in Stripe Elements.

Action Parameters

enabled
payment_method_domain
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Payout

Description

Tool to update a Stripe payout's metadata. Use when you need to attach or modify additional information on an existing payout. Note that only metadata can be updated; other payout properties (amount, destination, status, etc.) cannot be modified after creation.

Action Parameters

metadata
payout_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Plan

Description

Tool to update a Stripe plan by setting the values of the parameters passed. Use when you need to modify plan details like nickname, metadata, or active status. Note: You cannot change a plan's ID, amount, currency, or billing cycle by design.

Action Parameters

active
metadata
nickname
plan
stringRequired
product
trial_period_days

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a price

Description

Updates a Stripe price by setting passed parameter values; unspecified parameters remain unchanged. Use when you need to modify price metadata, active status, lookup key, or nickname. Note: Price amounts cannot be modified via API.

Action Parameters

active
currency_options
lookup_key
metadata
nickname
price
stringRequired
tax_behavior
transfer_lookup_key

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update product

Description

Tool to update an existing product in Stripe. Use when you need to modify product details like name, description, pricing, or availability.

Action Parameters

active
default_price
description
id
stringRequired
images
marketing_features
metadata
name
package_dimensions
shippable
statement_descriptor
tax_code
unit_label
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Promotion Code

Description

Updates an existing Stripe promotion code by setting the values of the parameters passed. Use when you need to activate/deactivate a promotion code, update its metadata, or modify redemption restrictions. Most promotion code fields are intentionally non-editable after creation.

Action Parameters

active
id
stringRequired
metadata
restrictions

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a refund

Description

Tool to update a Stripe refund's metadata. Use when you need to add or modify metadata on an existing refund. This request only accepts metadata as an argument.

Action Parameters

metadata
refund
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Setup Intent

Description

Updates an existing SetupIntent with new configuration or payment details. Use when you need to modify a SetupIntent before it is confirmed.

Action Parameters

attach_to_self
customer
customer_account
description
flow_directions
metadata
payment_method
payment_method_configuration
payment_method_data
payment_method_options
payment_method_types
setup_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update shipping rate

Description

Tool to update an existing Stripe shipping rate. Use when you need to modify properties like active status, pricing, or metadata.

Action Parameters

active
fixed_amount
metadata
shipping_rate_token
stringRequired
tax_behavior

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Subscription

Description

Updates an existing, non-canceled Stripe subscription by its ID, ensuring all referenced entity IDs (e.g., prices, coupons) are valid and automatic tax liability is correctly specified if enabled.

Action Parameters

automatic_tax
billing_cycle_anchor
cancel_at_period_end
collection_method
default_payment_method
description
items
metadata
payment_behavior
proration_behavior
subscription_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update subscription item

Description

Tool to update a subscription item's configuration including price, quantity, metadata, and billing thresholds. Use when modifying an existing subscription item. Changes may trigger prorations.

Action Parameters

billing_thresholds
discounts
metadata
off_session
payment_behavior
price
price_data
proration_behavior
proration_date
quantity
subscription_item_id
stringRequired
tax_rates

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Validate payment method domain

Description

Tool to validate an existing payment method domain. Use this after completing required registration steps for a specific payment method to activate it on the domain.

Action Parameters

payment_method_domain_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify microdeposits on setup intent

Description

Verifies microdeposits on a SetupIntent object to confirm bank account ownership. Use when customer needs to verify their bank account using either amounts or descriptor code from microdeposits.

Action Parameters

amounts
descriptor_code
setup_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify microdeposits on payment intent

Description

Verifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code. Use after microdeposits are sent to complete bank account verification.

Action Parameters

amounts
descriptor_code
intent
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Verify setup intent microdeposits

Description

Verifies microdeposits on a SetupIntent object to complete bank account verification. Use either the two microdeposit amounts or the descriptor code that appears on the customer's bank statement.

Action Parameters

amounts
descriptor_code
setup_intent_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Void a finalized invoice

Description

Tool to mark a finalized invoice as void. Use when you need to cancel a finalized invoice that has not been paid. This operation is irreversible and preserves the invoice for audit purposes while preventing any payment collection.

Action Parameters

invoice_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired