IntegrationsPayments & FinanceStripe

Stripe

Description: Empower your agents to interact with the Stripe API.

Author: Arcade

Code: GitHub

Auth: API Key

PyPI VersionLicensePython VersionsWheel StatusDownloads

The Arcade Stripe toolkit lets you interact with the Stripe API. Use these tools to build intelligent agents and applications that process payments, create invoices, and more.

Install

pip install arcade_stripe

pip installing the toolkit is only needed if you are self-hosting Arcade. You do not need to install the toolkit if you’re using Arcade Cloud.

Available Tools

Tool NameDescription
CreateCustomerThis tool will create a customer in Stripe.
ListCustomersThis tool will fetch a list of Customers from Stripe.
CreateProductThis tool will create a product in Stripe.
ListProductsThis tool will fetch a list of Products from Stripe.
CreatePriceThis tool will create a price in Stripe. If a product has not already been
ListPricesThis tool will fetch a list of Prices from Stripe.
CreatePaymentLinkThis tool will create a payment link in Stripe.
ListInvoicesThis tool will list invoices in Stripe.
CreateInvoiceThis tool will create an invoice in Stripe.
CreateInvoiceItemThis tool will create an invoice item in Stripe.
FinalizeInvoiceThis tool will finalize an invoice in Stripe.
RetrieveBalanceThis tool will retrieve the balance from Stripe. It takes no input.
CreateRefundThis tool will refund a payment intent in Stripe.
ListPaymentIntentsThis tool will list payment intents in Stripe.
CreateBillingPortalSessionThis tool will create a billing portal session.

If you need an action that’s not listed here, please contact us to request a new tool, or create your own tools.

CreateCustomer

Create a customer in Stripe.

Parameters

  • name (string, required): The name of the customer.
  • email (string, optional): The email address of the customer.

ListCustomers

Fetch a list of customers from Stripe.

Parameters

  • limit (int, optional, defaults to 10): A limit on the number of objects to be returned. Limit can range between 1 and 100.
  • email (string, optional): A case-sensitive filter on the list based on the customer’s email field.

CreateProduct

Create a product in Stripe.

Parameters

  • name (string, required): The name of the product.
  • description (string, optional): The description of the product.

ListProducts

Fetch a list of products from Stripe.

Parameters

  • limit (int, optional, defaults to 10): A limit on the number of products returned. Limit can range between 1 and 100, and defaults to 10.

CreatePrice

Create a price in Stripe.

Parameters

  • product (string, required): The ID of the product to create the price for.
  • unit_amount (int, required): The unit amount of the price in cents.
  • currency (string, required): The currency of the price.

ListPrices

Fetch a list of prices from Stripe.

Parameters

  • product (string, optional): The ID of the product to list prices for.
  • limit (int, optional, defaults to 10): A limit on the number of objects to be returned. Limit can range between 1 and 100, and defaults to 10.

CreatePaymentLink

Create a payment link in Stripe.

Parameters

  • price (string, required): The ID of the price to create the payment link for.
  • quantity (int, required): The quantity of the product to include.

ListInvoices

List invoices in Stripe.

Parameters

  • customer (string, optional): The ID of the customer to list invoices for.
  • limit (int, optional, defaults to 10): A limit on the number of invoices returned. Limit can range between 1 and 100, and defaults to 10.

CreateInvoice

Create an invoice in Stripe.

Parameters

  • customer (string, required): The ID of the customer to create the invoice for.
  • days_until_due (int, optional): The number of days until the invoice is due.

CreateInvoiceItem

Create an invoice item in Stripe.

Parameters

  • customer (string, required): The ID of the customer to create the invoice item for.
  • price (string, required): The ID of the price for the item.
  • invoice (string, required): The ID of the invoice to create the item for.

FinalizeInvoice

Finalize an invoice in Stripe.

Parameters

  • invoice (string, required): The ID of the invoice to finalize.

RetrieveBalance

Retrieve the balance from Stripe. This tool takes no inputs.

CreateRefund

Refund a payment intent in Stripe.

Parameters

  • payment_intent (string, required): The ID of the PaymentIntent to refund.
  • amount (int, optional): The refund amount to refund in cents.

ListPaymentIntents

List payment intents in Stripe.

Parameters

  • customer (string, optional): The ID of the customer to list payment intents for.
  • limit (int, optional): A limit on the number of payment intents returned. Limit can range between 1 and 100, and defaults to 10.

CreateBillingPortalSession

Create a billing portal session in Stripe.

Parameters

  • customer (string, required): The ID of the customer to create the billing portal session for.
  • return_url (string, optional): The default URL to return to afterwards.

Auth

The Arcade Stripe toolkit uses the Stripe Agent Toolkit to interact with the Stripe API.

  • Required Secret:
    • STRIPE_SECRET_KEY: Your Stripe API key.
Code SandboxGoogle Finance