Stripe

Learn how to use Stripe with Composio

Overview

Enum

STRIPE

Description

Stripe is a payment processor that allows you to accept payments online.

Authentication Details

api_key
stringRequired

Actions

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

Action Parameters

customer
string
created
object
ending_before
string
limit
integer
starting_after
string

Action Response

data
array
successful
boolean
error

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

Action Parameters

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

Action Response

data
array
successful
boolean
error

Retrieves a subscription from stripe using the given subscription id.

Action Parameters

subscription_id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

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

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

Action Parameters

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

Creates a new customer record in stripe.

Action Parameters

name
string
email
string
phone
string
description
string
address
object

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

Creates a new product in stripe.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Creates a draft invoice for a given customer in stripe.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Retrieves an existing customer’s information from stripe.

Action Parameters

customer_id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
array
successful
boolean
error

Creates a paymentintent in stripe to initiate a payment.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
array
successful
boolean
error

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

Action Parameters

subscription_id
stringRequired
cancellation_details
object
invoice_now
boolean
prorate
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

customer
stringRequired
items
arrayRequired
automatic_tax
object
cancel_at_period_end
boolean
currency
string
default_payment_method
string
description
string
metadata
object
payment_behavior
string
collection_method
stringDefaults to charge_automatically
add_invoice_items
array
application_fee_percent
number
backdate_start_date
integer
billing_cycle_anchor
integer
billing_cycle_anchor_config
object
billing_thresholds
object
cancel_at
integer
days_until_due
integer
default_source
string
default_tax_rates
array
discounts
array
invoice_settings
object
off_session
boolean
on_behalf_of
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
successful
boolean
error

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

Action Parameters

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

Action Response

data
array
successful
boolean
error