Visão Geral
Permita que seus agentes gerenciem pagamentos, assinaturas e faturamento de clientes através do Stripe. Gerencie dados de clientes, processe assinaturas, gerencie produtos e acompanhe transações financeiras para otimizar seus fluxos de pagamento com automação impulsionada por IA.Pré-requisitos
Antes de usar a integração com o Stripe, certifique-se de que você tem:- Uma conta CrewAI AMP com uma assinatura ativa
- Uma conta Stripe com permissões apropriadas de API
- Sua conta Stripe conectada através da página de Integrações
Configurando a Integração Stripe
1. Conecte sua Conta Stripe
- Acesse CrewAI AMP Integrações
- Encontre Stripe na seção Integrações de Autenticação
- Clique em Conectar e complete o fluxo OAuth
- Conceda as permissões necessárias para processamento de pagamentos
- Copie seu Token Enterprise em Configurações de Integração
2. Instale o Pacote Necessário
3. Configuração de variável de ambiente
Para usar integrações com
Agent(apps=[]), você deve definir a variável de ambiente CREWAI_PLATFORM_INTEGRATION_TOKEN com seu Enterprise Token..env:
Ferramentas Disponíveis
Gerenciamento de Clientes
stripe/create_customer
stripe/create_customer
Descrição: Crie um novo cliente em sua conta Stripe.Parâmetros:
emailCreateCustomer(string, obrigatório): Endereço de e-mail do clientename(string, opcional): Nome completo do clientedescription(string, opcional): Descrição do cliente para referência internametadataCreateCustomer(objeto, opcional): Metadados adicionais como pares chave-valor (exemplo:{"field1": 1, "field2": 2})
stripe/get_customer_by_id
stripe/get_customer_by_id
Descrição: Recupera um cliente específico pelo ID do cliente Stripe.Parâmetros:
idGetCustomer(string, obrigatório): O ID do cliente Stripe a ser recuperado
stripe/get_customers
stripe/get_customers
Descrição: Recupera uma lista de clientes com filtragem opcional.Parâmetros:
emailGetCustomers(string, opcional): Filtra clientes pelo endereço de e-mailcreatedAfter(string, opcional): Filtra clientes criados após esta data (timestamp Unix)createdBefore(string, opcional): Filtra clientes criados antes desta data (timestamp Unix)limitGetCustomers(string, opcional): Número máximo de clientes a retornar (padrão: 10)
stripe/update_customer
stripe/update_customer
Descrição: Atualiza as informações de um cliente existente.Parâmetros:
customerId(string, obrigatório): O ID do cliente a ser atualizadoemailUpdateCustomer(string, opcional): Novo endereço de e-mailname(string, opcional): Novo nome do clientedescription(string, opcional): Nova descrição do clientemetadataUpdateCustomer(objeto, opcional): Novos metadados como pares chave-valor
Gerenciamento de Assinaturas
stripe/create_subscription
stripe/create_subscription
Descrição: Cria uma nova assinatura para um cliente.Parâmetros:
customerIdCreateSubscription(string, obrigatório): O ID do cliente para o qual a assinatura será criadaplan(string, obrigatório): O ID do plano para assinatura - Use as Configurações do Workflow do Portal Connect para permitir que usuários selecionem um planometadataCreateSubscription(objeto, opcional): Metadados adicionais para a assinatura
stripe/get_subscriptions
stripe/get_subscriptions
Descrição: Recupera assinaturas com filtragem opcional.Parâmetros:
customerIdGetSubscriptions(string, opcional): Filtra assinaturas por ID do clientesubscriptionStatus(string, opcional): Filtra por status da assinatura - Opções: incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaidlimitGetSubscriptions(string, opcional): Número máximo de assinaturas a retornar (padrão: 10)
Gerenciamento de Produtos
stripe/create_product
stripe/create_product
Descrição: Cria um novo produto no seu catálogo Stripe.Parâmetros:
productName(string, obrigatório): Nome do produtodescription(string, opcional): Descrição do produtometadataProduct(objeto, opcional): Metadados adicionais do produto como pares chave-valor
stripe/get_product_by_id
stripe/get_product_by_id
Descrição: Recupera um produto específico pelo ID do produto Stripe.Parâmetros:
productId(string, obrigatório): O ID do produto Stripe a ser recuperado
stripe/get_products
stripe/get_products
Descrição: Recupera uma lista de produtos com filtragem opcional.Parâmetros:
createdAfter(string, opcional): Filtra produtos criados após esta data (timestamp Unix)createdBefore(string, opcional): Filtra produtos criados antes desta data (timestamp Unix)limitGetProducts(string, opcional): Número máximo de produtos a retornar (padrão: 10)
Operações Financeiras
stripe/get_balance_transactions
stripe/get_balance_transactions
Descrição: Recupera transações de saldo da sua conta Stripe.Parâmetros:
balanceTransactionType(string, opcional): Filtra por tipo de transação - Opções: charge, refund, payment, payment_refundpaginationParameters(objeto, opcional): Configurações de paginaçãopageCursor(string, opcional): Cursor da página para paginação
stripe/get_plans
stripe/get_plans
Descrição: Recupera planos de assinatura da sua conta Stripe.Parâmetros:
isPlanActive(boolean, opcional): Filtra por status do plano - true para planos ativos, false para inativospaginationParameters(objeto, opcional): Configurações de paginaçãopageCursor(string, opcional): Cursor da página para paginação
Exemplos de Uso
Configuração Básica do Agente Stripe
Filtrando Ferramentas Stripe Específicas
Gerenciamento de Assinaturas
Análises e Relatórios Financeiros
Referência de Status de Assinatura
Compreendendo os status de assinaturas:- incomplete - A assinatura requer método de pagamento ou confirmação de pagamento
- incomplete_expired - A assinatura expirou antes da confirmação do pagamento
- trialing - A assinatura está em período de avaliação
- active - A assinatura está ativa e em dia
- past_due - O pagamento falhou mas a assinatura ainda está ativa
- canceled - A assinatura foi cancelada
- unpaid - O pagamento falhou e a assinatura não está mais ativa
