Stripe

Learn how to use Stripe with Composio

Overview

Enum

STRIPE

Description

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

Authentication Details

api_key
stringRequired

Actions

Cancels a customer’s subscription in stripe immediately or at the end of the billing period.

Action Parameters

cancellation_details
object
invoice_now
boolean
prorate
boolean
subscription_id
stringRequired

Action Response

data
object
error
successful
boolean

Confirms a paymentintent in stripe, initiating payment with the current or provided payment method.

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
object
error
successful
boolean

Creates a new customer record in stripe.

Action Parameters

address
object
description
string
email
string
name
string
phone
string

Action Response

data
object
error
successful
boolean

Creates a draft invoice for a given customer in stripe.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Creates a paymentintent in stripe to initiate a payment.

Action Parameters

amount
integerRequired
application_fee_amount
integer
automatic_payment_methods
object
confirm
boolean
currency
stringRequired
customer
string
description
string
metadata
object
off_session
boolean
payment_method
string
payment_method_options
object
payment_method_types
array
receipt_email
string
return_url
string
setup_future_usage
string
shipping
object
statement_descriptor
string
statement_descriptor_suffix
string

Action Response

data
object
error
successful
boolean

Creates a new price for a product in stripe, handling both flat and nested fields.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Creates a new product in stripe.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Creates a refund for a charge or payment intent. this tool allows you to process full or partial refunds for payments made through stripe.

Action Parameters

amount
integer
charge
string
metadata
object
payment_intent
string
reason
string
refund_application_fee
boolean
reverse_transfer
boolean

Action Response

data
object
error
successful
boolean

Creates a new detailed subscription for an existing customer in stripe.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Permanently deletes a customer from your stripe account. when a customer is deleted: - they can no longer be retrieved - any active subscriptions are immediately canceled - all associated data (payment methods, subscriptions, and invoice history) is permanently removed this action is irreversible.

Action Parameters

customer_id
stringRequired

Action Response

data
object
error
successful
boolean

Retrieves a list of charges from stripe, optionally filtered by various parameters.

Action Parameters

created
object
customer
string
ending_before
string
limit
integer
payment_intent
string
starting_after
string
transfer_group
string

Action Response

data
array
error
successful
boolean

Action to list all coupons from your stripe account. this tool retrieves a list of all coupons from your stripe account. coupons can be used to apply discounts to customers’ purchases or subscriptions.

Action Parameters

ending_before
string
limit
integer
starting_after
string

Action Response

data
array
error
has_more
boolean
object
string
successful
boolean
url
string

Retrieves a list of customers from stripe, optionally filtered by various parameters.

Action Parameters

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

Action Response

data
array
error
successful
boolean

This tool retrieves a list of payment methods associated with a specific stripe customer. it fetches all paymentmethod objects that are attached to the given customer and supports parameters such as customer id, type, limit, starting after, and ending before for filtering and pagination.

Action Parameters

customer_id
stringRequired
ending_before
string
limit
integer
starting_after
string
type
string

Action Response

data
array
error
has_more
boolean
object
string
successful
boolean
url
string

Retrieves a list of invoices from stripe, optionally filtered by various parameters.

Action Parameters

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

Action Response

data
array
error
successful
boolean

Retrieves a list of paymentintents from stripe, optionally filtered by various parameters.

Action Parameters

created
object
customer
string
ending_before
string
limit
integer
starting_after
string

Action Response

data
array
error
successful
boolean

Retrieves a list of products from stripe, optionally filtered by various parameters.

Action Parameters

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

Action Response

data
array
error
successful
boolean

This tool retrieves a list of all refunds from your stripe account. it returns refunds in sorted order with the most recent appearing first. it supports filtering by charge, payment intent, creation date (with comparison operators), and pagination parameters such as ending before, starting after, and limit.

Action Parameters

charge
string
ending_before
string
limit
integer
payment_intent
string
starting_after
string

Action Response

data
array
error
has_more
boolean
object
string
successful
boolean
url
string

This tool retrieves a list of shipping rates from your stripe account using the get method. it supports filtering by active status, creation date, currency, and limit, and returns a list of shipping rate objects with details such as id, active status, display name, and more. this is useful for applications that need to display available shipping options or manage shipping configurations.

Action Parameters

active
boolean
created
object
currency
string
ending_before
string
limit
integer
starting_after
string

Action Response

data
array
error
has_more
boolean
object
string
successful
boolean
url
string

Retrieves a list of subscriptions from stripe, optionally filtered by various parameters.

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
array
error
successful
boolean

This tool retrieves a list of all tax codes available in stripe. tax codes classify goods and services for tax purposes and determine their tax behavior. the endpoint returns a paginated list of tax code objects, including details such as id, description, name, and additional pagination information (has more, url).

Action Parameters

ending_before
string
limit
integer
starting_after
string

Action Response

data
array
error
has_more
boolean
object
string
successful
boolean
url
string

This tool retrieves a list of all tax rates in your stripe account by offering filter options such as active/inactive, inclusive/exclusive, creation date, limit, and pagination using starting after and ending before. the tax rates are returned sorted by creation date with the most recent appearing first.

Action Parameters

active
boolean
created
object
ending_before
string
inclusive
boolean
limit
integer
starting_after
string

Action Response

data
array
error
has_more
boolean
object
string
successful
boolean
url
string

Retrieves the current account balance in stripe based on the authentication used for the request.

Action Parameters

Action Response

data
object
error
successful
boolean

Action to retrieve details of a specific charge from stripe.

Action Parameters

charge_id
stringRequired

Action Response

data
object
error
successful
boolean

Retrieves an existing customer’s information from stripe.

Action Parameters

customer_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves a paymentintent object using its id. a paymentintent tracks the process of collecting a payment from your customer and includes detailed information about the payment status, amount, and associated payment method. it is used for checking the status of a payment, verifying payment details, handling payment flow logic based on the paymentintent status, retrieving payment-related information for record-keeping, and debugging payment issues.

Action Parameters

client_secret
string
payment_intent_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves the details of a specific refund using the stripe api. it allows you to get comprehensive information about a refund that has been previously created, including refund id, amount, balance transaction details, associated charge, timestamp, currency, metadata, payment intent, refund reason, status, and transfer reversal details. it is particularly useful for monitoring refund status, verifying refund details, and maintaining accurate records of refund transactions.

Action Parameters

refund_id
stringRequired

Action Response

data
object
error
successful
boolean

Retrieves a subscription from stripe using the given subscription id.

Action Parameters

subscription_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool allows for searching customers using a query string with stripe’s search api. it provides powerful search capabilities by leveraging stripe’s query language, allowing advanced search operations such as exact matches, range queries, multiple conditions, and boolean operations. it is particularly useful for finding customers by metadata, creation date ranges, and partial text matches.

Action Parameters

limit
integer
page
string
query
stringRequired

Action Response

data
array
error
has_more
boolean
next_page
object
string
successful
boolean
url
string

Updates an existing customer’s information in stripe with bracket-notation flattening.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Updates properties on a paymentintent object without confirming it. this action allows you to modify various properties of an existing paymentintent, such as the amount, metadata, payment method, or customer details. depending on which properties you update, you might need to confirm the paymentintent again. for example, updating the payment method always requires confirmation.

Action Parameters

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

Action Response

data
object
error
successful
boolean

Updates an existing subscription in stripe with bracket-notation flattening.

Action Parameters

automatic_tax
object
billing_cycle_anchor
integer
cancel_at_period_end
boolean
collection_method
string
default_payment_method
string
description
string
items
array
metadata
object
payment_behavior
string
proration_behavior
string
subscription_id
stringRequired

Action Response

data
object
error
successful
boolean