Integração Stripe
Processamento de pagamentos e gerenciamento de assinaturas com integração Stripe para CrewAI.
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 Enterprise 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
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
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.