Pular para o conteúdo principal

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:

Configurando a Integração Stripe

1. Conecte sua Conta Stripe

  1. Acesse CrewAI AMP Integrações
  2. Encontre Stripe na seção Integrações de Autenticação
  3. Clique em Conectar e complete o fluxo OAuth
  4. Conceda as permissões necessárias para processamento de pagamentos
  5. 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.
Ou adicione ao seu arquivo .env:

Ferramentas Disponíveis

Gerenciamento de Clientes

Descrição: Crie um novo cliente em sua conta Stripe.Parâmetros:
  • emailCreateCustomer (string, obrigatório): Endereço de e-mail do cliente
  • name (string, opcional): Nome completo do cliente
  • description (string, opcional): Descrição do cliente para referência interna
  • metadataCreateCustomer (objeto, opcional): Metadados adicionais como pares chave-valor (exemplo: {"field1": 1, "field2": 2})
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
Descrição: Recupera uma lista de clientes com filtragem opcional.Parâmetros:
  • emailGetCustomers (string, opcional): Filtra clientes pelo endereço de e-mail
  • createdAfter (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)
Descrição: Atualiza as informações de um cliente existente.Parâmetros:
  • customerId (string, obrigatório): O ID do cliente a ser atualizado
  • emailUpdateCustomer (string, opcional): Novo endereço de e-mail
  • name (string, opcional): Novo nome do cliente
  • description (string, opcional): Nova descrição do cliente
  • metadataUpdateCustomer (objeto, opcional): Novos metadados como pares chave-valor

Gerenciamento de Assinaturas

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á criada
  • plan (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 plano
  • metadataCreateSubscription (objeto, opcional): Metadados adicionais para a assinatura
Descrição: Recupera assinaturas com filtragem opcional.Parâmetros:
  • customerIdGetSubscriptions (string, opcional): Filtra assinaturas por ID do cliente
  • subscriptionStatus (string, opcional): Filtra por status da assinatura - Opções: incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid
  • limitGetSubscriptions (string, opcional): Número máximo de assinaturas a retornar (padrão: 10)

Gerenciamento de Produtos

Descrição: Cria um novo produto no seu catálogo Stripe.Parâmetros:
  • productName (string, obrigatório): Nome do produto
  • description (string, opcional): Descrição do produto
  • metadataProduct (objeto, opcional): Metadados adicionais do produto como pares chave-valor
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
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

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_refund
  • paginationParameters (objeto, opcional): Configurações de paginação
    • pageCursor (string, opcional): Cursor da página para paginação
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 inativos
  • paginationParameters (objeto, opcional): Configurações de paginação
    • pageCursor (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

Uso de Metadados

Os metadados permitem que você armazene informações adicionais sobre clientes, assinaturas e produtos:
Esta integração permite uma automação abrangente do gerenciamento de pagamentos e assinaturas, possibilitando que seus agentes de IA administrem operações de faturamento perfeitamente dentro do seu ecossistema Stripe.