Sim

Stripe

Process payments and manage Stripe data

Stripe is a powerful payments platform that enables you to easily manage payments, customers, subscriptions, invoices, products, and more.

With Stripe integrated into Sim, your agents can:

  • Create and manage payment intents: Process payments with flexible configuration options.
  • Work with customers: Create, retrieve, and update customer records for your business.
  • Handle subscriptions: Manage recurring billing and subscription lifecycles.
  • Create and send invoices: Generate invoices for one-time or recurring payments.
  • Track and manage charges: Retrieve and update charge objects for monitoring payments.
  • Configure products and prices: Set up your catalog of products, pricing models, and offers.
  • Listen and react to Stripe events: Trigger workflows in response to payment updates, successful charges, and other Stripe events.

By connecting Sim with Stripe, you enable seamless automation and financial operations within your agent workflows. Automate customer onboarding, subscription management, payment collection, invoice generation, and even custom actions when payment events occur—all handled directly by your agents, securely via Stripe.

Whether you’re building e-commerce automation, subscription services, or running reporting and reconciliation, the Stripe tool makes it easy to coordinate payments and financial data within your intelligent Sim workflows.

Usage Instructions

Integrates Stripe into the workflow. Manage payment intents, customers, subscriptions, invoices, charges, products, prices, and events. Can be used in trigger mode to trigger a workflow when a Stripe event occurs.

Tools

stripe_create_payment_intent

Create a new Payment Intent to process a payment

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
amountnumberYesAmount in cents (e.g., 2000 for $20.00)
currencystringYesThree-letter ISO currency code (e.g., usd, eur)
customerstringNoCustomer ID to associate with this payment
payment_methodstringNoPayment method ID
descriptionstringNoDescription of the payment
receipt_emailstringNoEmail address to send receipt to
metadatajsonNoSet of key-value pairs for storing additional information
automatic_payment_methodsjsonNoEnable automatic payment methods (e.g., {"enabled": true})

Output

ParameterTypeDescription
payment_intentjsonThe created Payment Intent object
metadatajsonPayment Intent metadata including ID, status, amount, and currency

stripe_retrieve_payment_intent

Retrieve an existing Payment Intent by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPayment Intent ID (e.g., pi_1234567890)

Output

ParameterTypeDescription
payment_intentjsonThe retrieved Payment Intent object
metadatajsonPayment Intent metadata including ID, status, amount, and currency

stripe_update_payment_intent

Update an existing Payment Intent

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPayment Intent ID (e.g., pi_1234567890)
amountnumberNoUpdated amount in cents
currencystringNoThree-letter ISO currency code
customerstringNoCustomer ID
descriptionstringNoUpdated description
metadatajsonNoUpdated metadata

Output

ParameterTypeDescription
payment_intentjsonThe updated Payment Intent object
metadatajsonPayment Intent metadata including ID, status, amount, and currency

stripe_confirm_payment_intent

Confirm a Payment Intent to complete the payment

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPayment Intent ID (e.g., pi_1234567890)
payment_methodstringNoPayment method ID to confirm with

Output

ParameterTypeDescription
payment_intentjsonThe confirmed Payment Intent object
metadatajsonPayment Intent metadata including ID, status, amount, and currency

stripe_capture_payment_intent

Capture an authorized Payment Intent

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPayment Intent ID (e.g., pi_1234567890)
amount_to_capturenumberNoAmount to capture in cents (defaults to full amount)

Output

ParameterTypeDescription
payment_intentjsonThe captured Payment Intent object
metadatajsonPayment Intent metadata including ID, status, amount, and currency

stripe_cancel_payment_intent

Cancel a Payment Intent

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPayment Intent ID (e.g., pi_1234567890)
cancellation_reasonstringNoReason for cancellation (duplicate, fraudulent, requested_by_customer, abandoned)

Output

ParameterTypeDescription
payment_intentjsonThe canceled Payment Intent object
metadatajsonPayment Intent metadata including ID, status, amount, and currency

stripe_list_payment_intents

List all Payment Intents

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
customerstringNoFilter by customer ID
createdjsonNoFilter by creation date (e.g., {"gt": 1633024800})

Output

ParameterTypeDescription
payment_intentsjsonArray of Payment Intent objects
metadatajsonList metadata including count and has_more

stripe_search_payment_intents

Search for Payment Intents using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "status:'succeeded' AND currency:'usd'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
payment_intentsjsonArray of matching Payment Intent objects
metadatajsonSearch metadata including count and has_more

stripe_create_customer

Create a new customer object

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
emailstringNoCustomer email address
namestringNoCustomer full name
phonestringNoCustomer phone number
descriptionstringNoDescription of the customer
addressjsonNoCustomer address object
metadatajsonNoSet of key-value pairs
payment_methodstringNoPayment method ID to attach

Output

ParameterTypeDescription
customerjsonThe created customer object
metadatajsonCustomer metadata

stripe_retrieve_customer

Retrieve an existing customer by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesCustomer ID (e.g., cus_1234567890)

Output

ParameterTypeDescription
customerjsonThe retrieved customer object
metadatajsonCustomer metadata

stripe_update_customer

Update an existing customer

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesCustomer ID (e.g., cus_1234567890)
emailstringNoUpdated email address
namestringNoUpdated name
phonestringNoUpdated phone number
descriptionstringNoUpdated description
addressjsonNoUpdated address object
metadatajsonNoUpdated metadata

Output

ParameterTypeDescription
customerjsonThe updated customer object
metadatajsonCustomer metadata

stripe_delete_customer

Permanently delete a customer

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesCustomer ID (e.g., cus_1234567890)

Output

ParameterTypeDescription
deletedbooleanWhether the customer was deleted
idstringThe ID of the deleted customer
metadatajsonDeletion metadata

stripe_list_customers

List all customers

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
emailstringNoFilter by email address
createdjsonNoFilter by creation date

Output

ParameterTypeDescription
customersjsonArray of customer objects
metadatajsonList metadata

stripe_search_customers

Search for customers using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "email:'customer@example.com'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
customersjsonArray of matching customer objects
metadatajsonSearch metadata

stripe_create_subscription

Create a new subscription for a customer

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
customerstringYesCustomer ID to subscribe
itemsjsonYesArray of items with price IDs (e.g., [{"price": "price_xxx", "quantity": 1}])
trial_period_daysnumberNoNumber of trial days
default_payment_methodstringNoPayment method ID
cancel_at_period_endbooleanNoCancel subscription at period end
metadatajsonNoSet of key-value pairs for storing additional information

Output

ParameterTypeDescription
subscriptionjsonThe created subscription object
metadatajsonSubscription metadata including ID, status, and customer

stripe_retrieve_subscription

Retrieve an existing subscription by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesSubscription ID (e.g., sub_1234567890)

Output

ParameterTypeDescription
subscriptionjsonThe retrieved subscription object
metadatajsonSubscription metadata including ID, status, and customer

stripe_update_subscription

Update an existing subscription

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesSubscription ID (e.g., sub_1234567890)
itemsjsonNoUpdated array of items with price IDs
cancel_at_period_endbooleanNoCancel subscription at period end
metadatajsonNoUpdated metadata

Output

ParameterTypeDescription
subscriptionjsonThe updated subscription object
metadatajsonSubscription metadata including ID, status, and customer

stripe_cancel_subscription

Cancel a subscription

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesSubscription ID (e.g., sub_1234567890)
proratebooleanNoWhether to prorate the cancellation
invoice_nowbooleanNoWhether to invoice immediately

Output

ParameterTypeDescription
subscriptionjsonThe canceled subscription object
metadatajsonSubscription metadata including ID, status, and customer

stripe_resume_subscription

Resume a subscription that was scheduled for cancellation

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesSubscription ID (e.g., sub_1234567890)

Output

ParameterTypeDescription
subscriptionjsonThe resumed subscription object
metadatajsonSubscription metadata including ID, status, and customer

stripe_list_subscriptions

List all subscriptions

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
customerstringNoFilter by customer ID
statusstringNoFilter by status (active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, all)
pricestringNoFilter by price ID

Output

ParameterTypeDescription
subscriptionsjsonArray of subscription objects
metadatajsonList metadata

stripe_search_subscriptions

Search for subscriptions using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "status:'active' AND customer:'cus_xxx'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
subscriptionsjsonArray of matching subscription objects
metadatajsonSearch metadata

stripe_create_invoice

Create a new invoice

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
customerstringYesCustomer ID (e.g., cus_1234567890)
descriptionstringNoDescription of the invoice
metadatajsonNoSet of key-value pairs
auto_advancebooleanNoAuto-finalize the invoice
collection_methodstringNoCollection method: charge_automatically or send_invoice

Output

ParameterTypeDescription
invoicejsonThe created invoice object
metadatajsonInvoice metadata

stripe_retrieve_invoice

Retrieve an existing invoice by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)

Output

ParameterTypeDescription
invoicejsonThe retrieved invoice object
metadatajsonInvoice metadata

stripe_update_invoice

Update an existing invoice

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)
descriptionstringNoDescription of the invoice
metadatajsonNoSet of key-value pairs
auto_advancebooleanNoAuto-finalize the invoice

Output

ParameterTypeDescription
invoicejsonThe updated invoice object
metadatajsonInvoice metadata

stripe_delete_invoice

Permanently delete a draft invoice

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)

Output

ParameterTypeDescription
deletedbooleanWhether the invoice was deleted
idstringThe ID of the deleted invoice
metadatajsonDeletion metadata

stripe_finalize_invoice

Finalize a draft invoice

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)
auto_advancebooleanNoAuto-advance the invoice

Output

ParameterTypeDescription
invoicejsonThe finalized invoice object
metadatajsonInvoice metadata

stripe_pay_invoice

Pay an invoice

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)
paid_out_of_bandbooleanNoMark invoice as paid out of band

Output

ParameterTypeDescription
invoicejsonThe paid invoice object
metadatajsonInvoice metadata

stripe_void_invoice

Void an invoice

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)

Output

ParameterTypeDescription
invoicejsonThe voided invoice object
metadatajsonInvoice metadata

stripe_send_invoice

Send an invoice to the customer

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesInvoice ID (e.g., in_1234567890)

Output

ParameterTypeDescription
invoicejsonThe sent invoice object
metadatajsonInvoice metadata

stripe_list_invoices

List all invoices

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
customerstringNoFilter by customer ID
statusstringNoFilter by invoice status

Output

ParameterTypeDescription
invoicesjsonArray of invoice objects
metadatajsonList metadata

stripe_search_invoices

Search for invoices using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "customer:'cus_1234567890'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
invoicesjsonArray of matching invoice objects
metadatajsonSearch metadata

stripe_create_charge

Create a new charge to process a payment

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
amountnumberYesAmount in cents (e.g., 2000 for $20.00)
currencystringYesThree-letter ISO currency code (e.g., usd, eur)
customerstringNoCustomer ID to associate with this charge
sourcestringNoPayment source ID (e.g., card token or saved card ID)
descriptionstringNoDescription of the charge
metadatajsonNoSet of key-value pairs for storing additional information
capturebooleanNoWhether to immediately capture the charge (defaults to true)

Output

ParameterTypeDescription
chargejsonThe created Charge object
metadatajsonCharge metadata including ID, status, amount, currency, and paid status

stripe_retrieve_charge

Retrieve an existing charge by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesCharge ID (e.g., ch_1234567890)

Output

ParameterTypeDescription
chargejsonThe retrieved Charge object
metadatajsonCharge metadata including ID, status, amount, currency, and paid status

stripe_update_charge

Update an existing charge

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesCharge ID (e.g., ch_1234567890)
descriptionstringNoUpdated description
metadatajsonNoUpdated metadata

Output

ParameterTypeDescription
chargejsonThe updated Charge object
metadatajsonCharge metadata including ID, status, amount, currency, and paid status

stripe_capture_charge

Capture an uncaptured charge

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesCharge ID (e.g., ch_1234567890)
amountnumberNoAmount to capture in cents (defaults to full amount)

Output

ParameterTypeDescription
chargejsonThe captured Charge object
metadatajsonCharge metadata including ID, status, amount, currency, and paid status

stripe_list_charges

List all charges

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
customerstringNoFilter by customer ID
createdjsonNoFilter by creation date (e.g., {"gt": 1633024800})

Output

ParameterTypeDescription
chargesjsonArray of Charge objects
metadatajsonList metadata including count and has_more

stripe_search_charges

Search for charges using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "status:'succeeded' AND currency:'usd'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
chargesjsonArray of matching Charge objects
metadatajsonSearch metadata including count and has_more

stripe_create_product

Create a new product object

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
namestringYesProduct name
descriptionstringNoProduct description
activebooleanNoWhether the product is active
imagesjsonNoArray of image URLs for the product
metadatajsonNoSet of key-value pairs

Output

ParameterTypeDescription
productjsonThe created product object
metadatajsonProduct metadata

stripe_retrieve_product

Retrieve an existing product by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesProduct ID (e.g., prod_1234567890)

Output

ParameterTypeDescription
productjsonThe retrieved product object
metadatajsonProduct metadata

stripe_update_product

Update an existing product

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesProduct ID (e.g., prod_1234567890)
namestringNoUpdated product name
descriptionstringNoUpdated product description
activebooleanNoUpdated active status
imagesjsonNoUpdated array of image URLs
metadatajsonNoUpdated metadata

Output

ParameterTypeDescription
productjsonThe updated product object
metadatajsonProduct metadata

stripe_delete_product

Permanently delete a product

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesProduct ID (e.g., prod_1234567890)

Output

ParameterTypeDescription
deletedbooleanWhether the product was deleted
idstringThe ID of the deleted product
metadatajsonDeletion metadata

stripe_list_products

List all products

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
activebooleanNoFilter by active status

Output

ParameterTypeDescription
productsjsonArray of product objects
metadatajsonList metadata

stripe_search_products

Search for products using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "name:'shirt'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
productsjsonArray of matching product objects
metadatajsonSearch metadata

stripe_create_price

Create a new price for a product

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
productstringYesProduct ID (e.g., prod_1234567890)
currencystringYesThree-letter ISO currency code (e.g., usd, eur)
unit_amountnumberNoAmount in cents (e.g., 1000 for $10.00)
recurringjsonNoRecurring billing configuration (interval: day/week/month/year)
metadatajsonNoSet of key-value pairs
billing_schemestringNoBilling scheme (per_unit or tiered)

Output

ParameterTypeDescription
pricejsonThe created price object
metadatajsonPrice metadata

stripe_retrieve_price

Retrieve an existing price by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPrice ID (e.g., price_1234567890)

Output

ParameterTypeDescription
pricejsonThe retrieved price object
metadatajsonPrice metadata

stripe_update_price

Update an existing price

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesPrice ID (e.g., price_1234567890)
activebooleanNoWhether the price is active
metadatajsonNoUpdated metadata

Output

ParameterTypeDescription
pricejsonThe updated price object
metadatajsonPrice metadata

stripe_list_prices

List all prices

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
productstringNoFilter by product ID
activebooleanNoFilter by active status

Output

ParameterTypeDescription
pricesjsonArray of price objects
metadatajsonList metadata

stripe_search_prices

Search for prices using query syntax

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
querystringYesSearch query (e.g., "active:'true' AND currency:'usd'")
limitnumberNoNumber of results to return (default 10, max 100)

Output

ParameterTypeDescription
pricesjsonArray of matching price objects
metadatajsonSearch metadata

stripe_retrieve_event

Retrieve an existing Event by ID

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
idstringYesEvent ID (e.g., evt_1234567890)

Output

ParameterTypeDescription
eventjsonThe retrieved Event object
metadatajsonEvent metadata including ID, type, and created timestamp

stripe_list_events

List all Events

Input

ParameterTypeRequiredDescription
apiKeystringYesStripe API key (secret key)
limitnumberNoNumber of results to return (default 10, max 100)
typestringNoFilter by event type (e.g., payment_intent.created)
createdjsonNoFilter by creation date (e.g., {"gt": 1633024800})

Output

ParameterTypeDescription
eventsjsonArray of Event objects
metadatajsonList metadata including count and has_more

Notes

  • Category: tools
  • Type: stripe
On this page

On this page

Usage Instructions
Tools
stripe_create_payment_intent
Input
Output
stripe_retrieve_payment_intent
Input
Output
stripe_update_payment_intent
Input
Output
stripe_confirm_payment_intent
Input
Output
stripe_capture_payment_intent
Input
Output
stripe_cancel_payment_intent
Input
Output
stripe_list_payment_intents
Input
Output
stripe_search_payment_intents
Input
Output
stripe_create_customer
Input
Output
stripe_retrieve_customer
Input
Output
stripe_update_customer
Input
Output
stripe_delete_customer
Input
Output
stripe_list_customers
Input
Output
stripe_search_customers
Input
Output
stripe_create_subscription
Input
Output
stripe_retrieve_subscription
Input
Output
stripe_update_subscription
Input
Output
stripe_cancel_subscription
Input
Output
stripe_resume_subscription
Input
Output
stripe_list_subscriptions
Input
Output
stripe_search_subscriptions
Input
Output
stripe_create_invoice
Input
Output
stripe_retrieve_invoice
Input
Output
stripe_update_invoice
Input
Output
stripe_delete_invoice
Input
Output
stripe_finalize_invoice
Input
Output
stripe_pay_invoice
Input
Output
stripe_void_invoice
Input
Output
stripe_send_invoice
Input
Output
stripe_list_invoices
Input
Output
stripe_search_invoices
Input
Output
stripe_create_charge
Input
Output
stripe_retrieve_charge
Input
Output
stripe_update_charge
Input
Output
stripe_capture_charge
Input
Output
stripe_list_charges
Input
Output
stripe_search_charges
Input
Output
stripe_create_product
Input
Output
stripe_retrieve_product
Input
Output
stripe_update_product
Input
Output
stripe_delete_product
Input
Output
stripe_list_products
Input
Output
stripe_search_products
Input
Output
stripe_create_price
Input
Output
stripe_retrieve_price
Input
Output
stripe_update_price
Input
Output
stripe_list_prices
Input
Output
stripe_search_prices
Input
Output
stripe_retrieve_event
Input
Output
stripe_list_events
Input
Output
Notes
Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started