Stripe
Overview
Section titled “Overview”Stripe is the world’s leading online payment infrastructure platform, offering APIs to accept payments, prevent fraud, and manage charges, subscriptions, and global marketplaces. With the Stripe integration in SquadOS, your agents can create payment intents, manage customers, issue invoices, control subscriptions, and query account balances automatically.
- Official website: https://stripe.com/
- Composio documentation: docs.composio.dev/toolkits/stripe
Authentication
Section titled “Authentication”This tool uses an API key (API_KEY) or OAuth 2.0 (OAUTH2) to connect.
You will need the following fields (for API key connection):
| Field | Required | Description |
|---|---|---|
api_key | Yes | Your Stripe account API key (secret key, prefixed with sk_live_ in production or sk_test_ in test mode). |
How to get credentials
Section titled “How to get credentials”- Go to dashboard.stripe.com and log in (or create an account).
- Click the gear icon (Settings) in the top-right corner.
- In the side menu, go to Developers → API keys.
- Copy the Secret key (prefixed with
sk_live_for production). For testing, use thesk_test_key. - Use this value in the
api_keyfield when connecting in SquadOS.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Stripe. - Click the card to open the details and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above (or authorize access via OAuth 2.0).
- Once done, you’re sent back to SquadOS with the account connected and the tool available to agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Create payment intent
Section titled “Create payment intent”STRIPE_CREATE_PAYMENT_INTENT
Creates a Stripe PaymentIntent to initiate and process a customer’s payment; using application_fee_amount for a connected account requires the Stripe-Account header.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
amount | integer | Yes | Amount intended to be collected, specified in the smallest currency unit (e.g., 5000 for $50.00 USD). |
currency | string | Yes | Three-letter ISO currency code (e.g., usd, eur). |
confirm | boolean | No | Set to true to attempt to confirm this PaymentIntent immediately after creation. If the payment method requires any follow-up actions (e.g., 3D Secure authentication), this PaymentIntent will transition to a status requiring further action. |
customer | string | No | ID of the Customer for this PaymentIntent, if one exists. Allows attaching payment method to Customer for future use. |
metadata | object | No | Key-value pairs to attach to the PaymentIntent for storing additional structured information. |
shipping | object | No | Shipping information for this PaymentIntent. Required for certain payment methods or if calculating tax. |
return_url | string | No | URL to redirect customer to after external authentication (e.g., 3D Secure). Required if confirm is true and payment method requires redirection. |
description | string | No | Arbitrary string for the PaymentIntent, displayed in Stripe dashboard and may be shown to customers. |
off_session | string | No | Indicates if customer is absent (off-session, e.g., for renewals). If true, payment_method must be provided and confirm must be true. |
receipt_email | string | No | Email address for receipt; if specified in live mode, receipt sent regardless of account email settings. |
payment_method | string | No | ID of PaymentMethod, Card, or compatible Source to attach. Required if confirm is true and automatic_payment_methods is not enabled. |
setup_future_usage | string | No | Indicates intent to save payment method for future use: on_session (customer present) or off_session (customer absent). |
payment_method_types | array | No | List of payment method types (e.g., card, alipay) this PaymentIntent can use. Required if automatic_payment_methods is disabled. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Confirm payment intent
Section titled “Confirm payment intent”STRIPE_CONFIRM_PAYMENT_INTENT
Tool to confirm customer intent to pay with current or provided payment method. Use when ready to finalize a PaymentIntent and initiate the payment attempt. A return_url is required if confirmation needs customer action like 3D Secure authentication.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
payment_intent_id | string | Yes | The ID of the PaymentIntent to confirm. |
return_url | string | No | The URL to redirect your customer back to after they authenticate or cancel their payment. Required if confirmation requires customer action (e.g., 3D Secure). |
payment_method | string | No | ID of the PaymentMethod to attach to this PaymentIntent. |
off_session | string | No | Set to true to indicate customer is not in checkout flow. |
capture_method | string | No | Controls fund capture timing: automatic, automatic_async (default), or manual. |
setup_future_usage | string | No | Indicates intent to reuse payment method: on_session or off_session. |
confirmation_token | string | No | ID of the ConfirmationToken to use for confirmation. |
payment_method_data | object | No | Hash to create new PaymentMethod with type-specific details. Must include type field (e.g., card, acss_debit). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Capture payment intent
Section titled “Capture payment intent”STRIPE_CAPTURE_PAYMENT_INTENT
Captures the funds of an existing uncaptured PaymentIntent. Use when the PaymentIntent status is requires_capture.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
intent | string | Yes | The unique identifier of the PaymentIntent to capture. |
amount_to_capture | integer | No | Amount to capture in smallest currency unit. Must be less than or equal to the original amount. Defaults to full amount_capturable if not provided. |
metadata | object | No | Set of key-value pairs for storing additional structured data. |
final_capture | boolean | No | Defaults to true. Set to false to retain uncaptured funds for future captures (requires multicapture support). |
statement_descriptor | string | No | Custom statement descriptor for non-card charges. Maximum 22 characters. |
application_fee_amount | integer | No | Application fee to be transferred to the app owner’s Stripe account. Cannot exceed the captured amount. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Cancel payment intent
Section titled “Cancel payment intent”STRIPE_CANCEL_PAYMENT_INTENT
Cancels a PaymentIntent when in cancelable state. Use when a PaymentIntent is no longer needed to prevent further charges. For PaymentIntents with status=requires_capture, the remaining amount_capturable will be automatically refunded.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
payment_intent_id | string | Yes | The unique identifier of the PaymentIntent to cancel. |
cancellation_reason | string | No | Reason for canceling this PaymentIntent. Must be one of: duplicate, fraudulent, requested_by_customer, or abandoned. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
List payment intents
Section titled “List payment intents”STRIPE_LIST_PAYMENT_INTENTS
Tool to list PaymentIntents from Stripe. Use when you need to retrieve a list of payment intents with optional filtering by customer, creation date, or pagination parameters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
customer | string | No | Only return PaymentIntents for the customer specified by this customer ID. |
created | object | No | Filter by creation date using Unix timestamps. Supported keys: gt, gte, lt, lte. |
ending_before | string | No | A cursor for use in pagination. Object ID that defines your place in the list (for fetching the previous page). |
starting_after | string | No | A cursor for use in pagination. Object ID that defines your place in the list (for fetching the next page). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create Customer
Section titled “Create Customer”STRIPE_CREATE_CUSTOMER
Creates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | The customer’s full name or the name of the business. |
email | string | No | The customer’s primary email address, used by Stripe for sending invoices, receipts, and other important communications. |
phone | string | No | The customer’s primary phone number. Include the country code for international numbers (e.g., +1 for the USA). |
address | object | No | The customer’s billing address. Common keys include: line1, line2, city, state, postal_code, country (two-letter ISO country code, e.g., US, GB). |
description | string | No | An arbitrary string that you can attach to a customer object for your internal reference (not visible to the customer). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Update Customer
Section titled “Update Customer”STRIPE_UPDATE_CUSTOMER
Updates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The unique identifier of the Stripe customer to update. |
name | string | No | The customer’s full name or the business name. |
email | string | No | The customer’s email address. Updating this may trigger a verification email to the new address. |
phone | string | No | The customer’s primary phone number, preferably in E.164 format. |
address | object | No | Defines the customer’s primary billing address. |
metadata | object | No | Key-value pairs for storing additional, unstructured information. Keys up to 40 characters, values up to 500. |
description | string | No | An arbitrary string providing additional information about the customer. Maximum 5000 characters. |
default_payment_method | string | No | The ID of a PaymentMethod to set as the customer’s default for subscriptions and invoices. |
balance | integer | No | An integer representing the customer’s account balance in the smallest currency unit. Positive credits, negative debits. Applied to future invoices. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
List customers
Section titled “List customers”STRIPE_LIST_CUSTOMERS
Retrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
email | string | No | Filters customers by a case-sensitive email address. |
limit | integer | No | Maximum number of customer objects to return (range 1-100). Defaults to 10 if unspecified. |
created | object | No | Filters by creation date. Use a dictionary with keys like gte, lte, gt, lt and Unix timestamp values. |
ending_before | string | No | Pagination cursor; retrieves objects created before the specified object ID to fetch the previous page. |
starting_after | string | No | Pagination cursor; retrieves objects created after the specified object ID to fetch the next page. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Retrieve customer
Section titled “Retrieve customer”STRIPE_RETRIEVE_CUSTOMER
Retrieves detailed information for an existing Stripe customer using their unique customer ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | The unique identifier of the Stripe customer to retrieve. This ID typically starts with cus_. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Search Stripe customers
Section titled “Search Stripe customers”STRIPE_SEARCH_CUSTOMERS
Retrieves a list of Stripe customers matching a search query that adheres to Stripe’s Search Query Language.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The search query string using Stripe’s Search Query Language. Every query must include at least one field:value condition. Supported operators: : for exact match, ~ for substring match (minimum 3 characters), comparison operators for numeric/date fields. To retrieve many/all customers, use created>0. |
limit | integer | No | Maximum number of results per page (default is 10). |
page | string | No | Cursor token for pagination. MUST be the exact next_page value from a previous search response — NOT a numeric page number. Omit on first request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create Checkout Session
Section titled “Create Checkout Session”STRIPE_CREATE_CHECKOUT_SESSION
Tool to create a Stripe Checkout Session. Use when you need a secure, hosted URL to collect payments or subscriptions via Stripe Checkout.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
mode | string | Yes | Session mode: payment (one-time), setup (save payment method), or subscription. Note: setup mode does not use line_items. |
line_items | array | Yes | List of items the customer is purchasing. Each item must have either price (ID of existing Price) or price_data (inline price). Required for payment and subscription modes. |
success_url | string | Yes | URL to redirect customers after successful payment or setup. |
cancel_url | string | No | URL to redirect customers if they cancel payment. |
customer | string | No | ID of existing Customer to attach or prefill. |
metadata | object | No | Key-value pairs to attach to the session. |
payment_method_types | array | No | Payment methods to accept (e.g., ['card', 'ideal', 'sepa_debit']). Defaults to ['card'] if not specified. |
allow_promotion_codes | boolean | No | Whether to allow promotion codes in the session. |
client_reference_id | string | No | Your unique reference for the session. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create subscription
Section titled “Create subscription”STRIPE_CREATE_SUBSCRIPTION
Creates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer | string | Yes | ID of the existing Stripe customer. |
items | array | Yes | List of items (products/services and pricing) for the subscription. |
currency | string | No | Three-letter ISO currency code (lowercase) for the subscription. |
metadata | object | No | Key-value pairs for additional information about the subscription. |
trial_end | integer | No | Unix timestamp for trial end. Overrides plan trial period. During the trial, no payment is required. |
cancel_at | integer | No | Unix timestamp to schedule subscription cancellation. |
description | string | No | Arbitrary string describing the subscription. |
off_session | boolean | No | Allow initial payment attempt off-session (without direct customer interaction). |
promotion_code | string | No | ID of the promotion code to apply. |
days_until_due | integer | No | Days until invoice is due (for send_invoice collection method). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Cancel subscription
Section titled “Cancel subscription”STRIPE_CANCEL_SUBSCRIPTION
Cancels a customer’s active Stripe subscription at the end of the current billing period, with options to invoice immediately for metered usage and prorate charges for unused time.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Identifier of the subscription to cancel. |
prorate | boolean | No | If true, generates a proration invoice item for unused time remaining in the current billing cycle. |
invoice_now | boolean | No | If true, generates a final invoice for any un-invoiced metered usage. |
cancellation_details | object | No | Specifies reasons for cancellation. Common keys: comment (free-form text) and feedback (e.g., customer_service, low_usage, switched_service). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
List subscriptions
Section titled “List subscriptions”STRIPE_LIST_SUBSCRIPTIONS
Retrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer | string | No | ID of the customer whose subscriptions will be retrieved. |
status | string | No | Filter subscriptions by status (e.g., active, all, canceled). Defaults to non-canceled statuses if unspecified. |
limit | integer | No | Limit on the number of subscription objects to return (1-100). Default is 10. |
price | string | No | ID of the recurring price to filter subscriptions by. |
created | object | No | Filter subscriptions by creation date using comparison keys and Unix timestamp values. |
collection_method | string | No | Filter subscriptions by collection method: charge_automatically or send_invoice. |
ending_before | string | No | Cursor for paginating backwards. |
starting_after | string | No | Cursor for paginating forwards. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Search subscriptions
Section titled “Search subscriptions”STRIPE_SEARCH_SUBSCRIPTIONS
Searches for subscriptions using Stripe’s Search Query Language. Use when you need to find subscriptions by status, metadata, created timestamp, or canceled_at timestamp.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The search query string using Stripe’s Search Query Language. Supported search fields for subscriptions: status, metadata, created (Unix timestamp), canceled_at (Unix timestamp). Supports exact matches, range queries, and boolean operators (AND, OR). |
limit | integer | No | Maximum number of results per page (default is 10, max is 100). |
page | string | No | Pagination cursor for a specific page; omit for the first page. Use next_page from a previous response for subsequent pages. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create an invoice
Section titled “Create an invoice”STRIPE_CREATE_INVOICE
Creates a new draft Stripe invoice for a customer; use to revise an existing invoice, bill for a specific subscription, or apply detailed customizations. Note: Stripe API enforces a maximum value of 99,999,999 (in smallest currency unit) for amount fields.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer | string | Yes | The ID of the customer to be billed. |
currency | string | No | The three-letter ISO currency code (e.g., usd, eur). Defaults to the customer’s currency. IMPORTANT: Cannot be used together with subscription. |
description | string | No | An arbitrary string attached to the invoice, often visible to the customer. |
metadata | object | No | A set of key-value pairs to store additional information about the object. |
due_date | integer | No | Unix timestamp for the invoice due date. Must be a future date. Only applicable when collection_method=send_invoice. |
auto_advance | boolean | No | Controls whether Stripe automatically finalizes and attempts payment on this invoice. When false, the invoice remains a draft. |
footer | string | No | A custom footer text to display on the invoice PDF. |
discounts | array | No | The discounts to apply to the invoice (coupon IDs or discount IDs). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
List Invoices
Section titled “List Invoices”STRIPE_LIST_INVOICES
Retrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer | string | No | ID of the customer whose invoices to retrieve. |
status | string | No | Filter invoices by status: draft, open, paid, uncollectible, or void. |
limit | integer | No | Maximum number of invoice objects to return (1-100). Defaults to 10 if not specified. |
subscription | string | No | ID of the subscription whose invoices to retrieve. |
created | object | No | Filter invoices by their creation date. Use keys like gt, gte, lt, lte with Unix timestamp values. |
collection_method | string | No | Filter by collection method: charge_automatically or send_invoice. |
ending_before | string | No | Cursor for backward pagination. |
starting_after | string | No | Cursor for forward pagination. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Search invoices
Section titled “Search invoices”STRIPE_SEARCH_INVOICES
Searches for invoices using Stripe’s Search Query Language. Use when you need to find invoices by status, total amount, customer, currency, or other criteria. Data is typically searchable within one minute, though propagation can lag up to an hour during outages.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The search query string using Stripe’s Search Query Language. Supported search fields for invoices: created, currency, customer, metadata, number, status, subscription, total. Supports exact matches, range queries, and boolean operators (AND, OR, NOT). Cannot mix AND with OR in the same query. |
limit | integer | No | Maximum number of results per page (default is 10). |
page | string | No | Pagination cursor for a specific page; omit for the first page. Use next_page from a previous response for subsequent pages. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create product
Section titled “Create product”STRIPE_CREATE_PRODUCT
Creates a new product in Stripe, encoding the request as application/x-www-form-urlencoded by flattening nested structures.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Product’s name, displayed to customers. |
description | string | No | Product description, displayed to customers, providing more details. |
active | boolean | No | Indicates if the product is available for purchase. Set to false to archive. |
images | array | No | Up to 8 image URLs for display on product pages or checkout. |
metadata | object | No | Key-value pairs for storing additional structured information. |
url | string | No | Publicly accessible URL for the product’s webpage or landing page. |
tax_code | string | No | Stripe tax code ID for determining tax rates on sales. |
shippable | boolean | No | Indicates if the product is a physical good requiring shipping. |
statement_descriptor | string | No | String (max 22 chars) for customer credit card statements. |
default_price_data | object | No | Data used to create a new Price object as the default price for this product. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create a price
Section titled “Create a price”STRIPE_CREATE_PRICE
Creates a new Stripe Price for a product, defining its charges (one-time or recurring) and billing scheme; requires either an existing product ID or product_data.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | Three-letter ISO currency code (e.g., usd, eur). Must be a supported currency. |
product | string | No | The ID of the product this price is for. Required if product_data is not provided. |
unit_amount | integer | No | The base charge amount in the smallest currency unit (e.g., cents for USD). Required if not using tiers, custom_unit_amount, or currency_options. |
recurring | object | No | Specifies recurring components of a price, such as billing interval and usage type. |
active | boolean | No | Whether the price can be used for new purchases. Defaults to true. |
metadata | object | No | A set of key-value pairs to store additional information about the price. |
nickname | string | No | A brief, internal-facing description of the price. |
tax_behavior | string | No | Specifies how tax is applied: inclusive (included), exclusive (added), or unspecified. |
billing_scheme | string | No | Describes how to compute the price per period: per_unit (default) or tiered. |
product_data | object | No | Fields for creating a new product if a product ID is not provided with the price. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create Refund
Section titled “Create Refund”STRIPE_CREATE_REFUND
Creates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
charge | string | No | Identifier of the charge to refund. Required if payment_intent is not provided. |
payment_intent | string | No | Identifier of the PaymentIntent to refund. Required if charge is not provided. |
amount | integer | No | Amount in smallest currency unit (e.g., 1000 for $10.00 USD) to refund. If omitted, a full refund is issued. Cannot exceed the charge’s remaining refundable amount. |
reason | string | No | Reasons for issuing a refund: duplicate, fraudulent, or requested_by_customer. |
metadata | object | No | Key-value pairs to attach to the refund. |
reverse_transfer | boolean | No | Reverse an associated transfer? Reversal is proportional to refund amount. |
refund_application_fee | boolean | No | Refund the application fee? Full refunds refund the entire fee; partials refund proportionally. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create charge (deprecated)
Section titled “Create charge (deprecated)”STRIPE_CREATE_CHARGE
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.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
amount | integer | Yes | A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents for $1.00). Minimum $0.50 USD equivalent. |
currency | string | Yes | Three-letter ISO currency code, in lowercase. Must be a supported currency. |
source | string | No | Payment source to charge (card ID, bank account, source, token, or connected account). |
customer | string | No | ID of existing customer to charge. Maximum 500 characters. |
capture | boolean | No | Whether to immediately capture charge (defaults to true). When false, authorizes for later capture. |
description | string | No | An arbitrary string attached to a Charge object. Displayed in web interface and included in receipt emails. |
metadata | object | No | Key-value pairs for storing additional structured information. |
receipt_email | string | No | Email address for charge receipt delivery. Maximum 800 characters. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
List Charges
Section titled “List Charges”STRIPE_LIST_CHARGES
Retrieves a list of Stripe charges with filtering and pagination; use valid cursor IDs from previous responses for pagination, and note that charges are typically returned in reverse chronological order.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
customer | string | No | Filters charges by the specified customer ID. |
limit | integer | No | Maximum number of charges to return (default: 10). |
created | object | No | Filters charges by creation date using a dictionary with keys like gt, gte, lt, lte and Unix timestamp values. |
payment_intent | string | No | Filters charges by the specified PaymentIntent ID. |
ending_before | string | No | Cursor for pagination. A charge ID that defines your place in the list; returns charges listed before this charge. |
starting_after | string | No | Cursor for pagination. A charge ID that defines your place in the list; returns charges listed after this charge. |
transfer_group | string | No | Filters charges by the specified transfer group ID. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Retrieve Balance
Section titled “Retrieve Balance”STRIPE_RETRIEVE_BALANCE
Retrieves the complete current balance details for the connected Stripe account.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |