Skip to main content

Overview

Enable your agents to manage payments, subscriptions, and customer billing through Stripe. Handle customer data, process subscriptions, manage products, and track financial transactions to streamline your payment workflows with AI-powered automation.

Prerequisites

Before using the Stripe integration, ensure you have:
  • A CrewAI AMP account with an active subscription
  • A Stripe account with appropriate API permissions
  • Connected your Stripe account through the Integrations page

Setting Up Stripe Integration

1. Connect Your Stripe Account

  1. Navigate to CrewAI AMP Integrations
  2. Find Stripe in the Authentication Integrations section
  3. Click Connect and complete the OAuth flow
  4. Grant the necessary permissions for payment processing
  5. Copy your Enterprise Token from Integration Settings

2. Install Required Package

3. Environment Variable Setup

To use integrations with Agent(apps=[]), you must set the CREWAI_PLATFORM_INTEGRATION_TOKEN environment variable with your Enterprise Token.
Or add it to your .env file:

Available Tools

Customer Management

Description: Create a new customer in your Stripe account.Parameters:
  • emailCreateCustomer (string, required): Customer’s email address
  • name (string, optional): Customer’s full name
  • description (string, optional): Customer description for internal reference
  • metadataCreateCustomer (object, optional): Additional metadata as key-value pairs (e.g., {"field1": 1, "field2": 2})
Description: Retrieve a specific customer by their Stripe customer ID.Parameters:
  • idGetCustomer (string, required): The Stripe customer ID to retrieve
Description: Retrieve a list of customers with optional filtering.Parameters:
  • emailGetCustomers (string, optional): Filter customers by email address
  • createdAfter (string, optional): Filter customers created after this date (Unix timestamp)
  • createdBefore (string, optional): Filter customers created before this date (Unix timestamp)
  • limitGetCustomers (string, optional): Maximum number of customers to return (defaults to 10)
Description: Update an existing customer’s information.Parameters:
  • customerId (string, required): The ID of the customer to update
  • emailUpdateCustomer (string, optional): Updated email address
  • name (string, optional): Updated customer name
  • description (string, optional): Updated customer description
  • metadataUpdateCustomer (object, optional): Updated metadata as key-value pairs

Subscription Management

Description: Create a new subscription for a customer.Parameters:
  • customerIdCreateSubscription (string, required): The customer ID for whom the subscription will be created
  • plan (string, required): The plan ID for the subscription - Use Connect Portal Workflow Settings to allow users to select a plan
  • metadataCreateSubscription (object, optional): Additional metadata for the subscription
Description: Retrieve subscriptions with optional filtering.Parameters:
  • customerIdGetSubscriptions (string, optional): Filter subscriptions by customer ID
  • subscriptionStatus (string, optional): Filter by subscription status - Options: incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid
  • limitGetSubscriptions (string, optional): Maximum number of subscriptions to return (defaults to 10)

Product Management

Description: Create a new product in your Stripe catalog.Parameters:
  • productName (string, required): The product name
  • description (string, optional): Product description
  • metadataProduct (object, optional): Additional product metadata as key-value pairs
Description: Retrieve a specific product by its Stripe product ID.Parameters:
  • productId (string, required): The Stripe product ID to retrieve
Description: Retrieve a list of products with optional filtering.Parameters:
  • createdAfter (string, optional): Filter products created after this date (Unix timestamp)
  • createdBefore (string, optional): Filter products created before this date (Unix timestamp)
  • limitGetProducts (string, optional): Maximum number of products to return (defaults to 10)

Financial Operations

Description: Retrieve balance transactions from your Stripe account.Parameters:
  • balanceTransactionType (string, optional): Filter by transaction type - Options: charge, refund, payment, payment_refund
  • paginationParameters (object, optional): Pagination settings
    • pageCursor (string, optional): Page cursor for pagination
Description: Retrieve subscription plans from your Stripe account.Parameters:
  • isPlanActive (boolean, optional): Filter by plan status - true for active plans, false for inactive plans
  • paginationParameters (object, optional): Pagination settings
    • pageCursor (string, optional): Page cursor for pagination

Usage Examples

Basic Stripe Agent Setup

Filtering Specific Stripe Tools

Subscription Management

Financial Analytics and Reporting

Subscription Status Reference

Understanding subscription statuses:
  • incomplete - Subscription requires payment method or payment confirmation
  • incomplete_expired - Subscription expired before payment was confirmed
  • trialing - Subscription is in trial period
  • active - Subscription is active and current
  • past_due - Payment failed but subscription is still active
  • canceled - Subscription has been canceled
  • unpaid - Payment failed and subscription is no longer active

Metadata Usage

Metadata allows you to store additional information about customers, subscriptions, and products:
This integration enables comprehensive payment and subscription management automation, allowing your AI agents to handle billing operations seamlessly within your Stripe ecosystem.