Stripe

Visão geral

Stripe é a principal plataforma de infraestrutura de pagamentos online do mundo, oferecendo APIs para aceitar pagamentos, prevenir fraudes e gerenciar cobranças, assinaturas e marketplaces globalmente. Com a integração Stripe no SquadOS, seus agentes podem criar intenções de pagamento, gerenciar clientes, emitir faturas, controlar assinaturas e consultar o saldo da conta de forma automatizada.

• Site oficial: https://stripe.com/
• Documentação na Composio: docs.composio.dev/toolkits/stripe

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) ou OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos (para conexão via chave de API):

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API da sua conta Stripe (chave secreta, prefixada com sk_live_ em produção ou sk_test_ em testes).

Como obter a credencial

1. Acesse dashboard.stripe.com e faça login (ou crie uma conta).
2. Clique no ícone de engrenagem (Configurações) no canto superior direito.
3. No menu lateral, acesse Desenvolvedores → Chaves de API.
4. Copie a Chave secreta (prefixada com sk_live_ para produção). Para testes, use a chave sk_test_.
5. Use esse valor no campo api_key ao conectar no SquadOS.

Dica

Use chaves de teste (sk_test_) durante o desenvolvimento e chaves ao vivo (sk_live_) apenas em produção. As chaves secretas têm acesso completo à conta — nunca as exponha em código-fonte público.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Stripe.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima (ou autoriza o acesso via OAuth 2.0).
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Nota

Esta integração expõe 422 ações no total. Abaixo estão as principais; a lista completa está na documentação da Composio.

Criar intenção de pagamento

STRIPE_CREATE_PAYMENT_INTENT

Cria um PaymentIntent no Stripe para iniciar e processar o pagamento de um cliente. Usar application_fee_amount em uma conta conectada requer o cabeçalho Stripe-Account.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
amount	integer	Sim	Valor a cobrar, especificado na menor unidade da moeda (ex.: 5000 para R$ 50,00 ou US$ 50,00).
currency	string	Sim	Código ISO de três letras da moeda (ex.: usd, brl).
confirm	boolean	Não	Defina como true para tentar confirmar o PaymentIntent imediatamente após a criação. Se o método de pagamento exigir ações adicionais (ex.: autenticação 3D Secure), o PaymentIntent passará para o status de ação necessária.
customer	string	Não	ID do cliente Stripe para este PaymentIntent, se houver. Permite vincular o método de pagamento ao cliente para uso futuro.
metadata	object	Não	Pares chave-valor para armazenar informações adicionais estruturadas sobre o PaymentIntent.
shipping	object	Não	Informações de envio para este PaymentIntent. Necessário para certos métodos de pagamento ou ao calcular impostos.
return_url	string	Não	URL para redirecionar o cliente após autenticação externa (ex.: 3D Secure). Obrigatório se confirm for true e o método de pagamento exigir redirecionamento.
description	string	Não	String arbitrária para o PaymentIntent, exibida no painel Stripe e possivelmente mostrada ao cliente.
off_session	string	Não	Indica que o cliente está ausente (fora da sessão, ex.: para renovações). Se true, payment_method deve ser fornecido e confirm deve ser true.
receipt_email	string	Não	Endereço de e-mail para o recibo; em modo ao vivo, o recibo é enviado independentemente das configurações de e-mail da conta.
payment_method	string	Não	ID do método de pagamento, cartão ou fonte compatível a vincular. Obrigatório se confirm for true e automatic_payment_methods não estiver habilitado.
setup_future_usage	string	Não	Indica intenção de reutilizar o método de pagamento: on_session (cliente presente) ou off_session (cliente ausente).
payment_method_types	array	Não	Lista de tipos de método de pagamento (ex.: card, alipay) que este PaymentIntent pode usar. Obrigatório se automatic_payment_methods estiver desabilitado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Confirmar intenção de pagamento

STRIPE_CONFIRM_PAYMENT_INTENT

Confirma a intenção do cliente de pagar com o método de pagamento atual ou fornecido. Use quando estiver pronto para finalizar um PaymentIntent e iniciar a tentativa de pagamento. Um return_url é necessário se a confirmação exigir ação do cliente, como autenticação 3D Secure.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
payment_intent_id	string	Sim	O ID do PaymentIntent a confirmar.
return_url	string	Não	URL para redirecionar o cliente após autenticação ou cancelamento. Obrigatório se a confirmação exigir ação do cliente (ex.: 3D Secure).
payment_method	string	Não	ID do método de pagamento a vincular a este PaymentIntent.
off_session	string	Não	Defina como true para indicar que o cliente não está no fluxo de checkout.
capture_method	string	Não	Controla o momento da captura de fundos: automatic, automatic_async (padrão) ou manual.
setup_future_usage	string	Não	Indica intenção de reutilizar o método de pagamento: on_session ou off_session.
confirmation_token	string	Não	ID do ConfirmationToken a usar na confirmação.
payment_method_data	object	Não	Hash para criar um novo método de pagamento com detalhes específicos do tipo. Deve incluir o campo type (ex.: card, acss_debit).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Capturar intenção de pagamento

STRIPE_CAPTURE_PAYMENT_INTENT

Captura os fundos de um PaymentIntent não capturado existente. Use quando o status do PaymentIntent for requires_capture.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
intent	string	Sim	O identificador único do PaymentIntent a capturar.
amount_to_capture	integer	Não	Valor a capturar na menor unidade da moeda. Deve ser menor ou igual ao valor original. Padrão: valor total capturável.
metadata	object	Não	Pares chave-valor para armazenar informações adicionais estruturadas.
final_capture	boolean	Não	Padrão true. Defina como false para reter fundos não capturados para capturas futuras (requer suporte a multicaptura).
statement_descriptor	string	Não	Descritor de extrato personalizado para cobranças que não sejam de cartão. Máximo de 22 caracteres.
application_fee_amount	integer	Não	Taxa de aplicação a transferir para a conta do proprietário do app. Não pode exceder o valor capturado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Cancelar intenção de pagamento

STRIPE_CANCEL_PAYMENT_INTENT

Cancela um PaymentIntent quando está em estado cancelável. Use quando um PaymentIntent não for mais necessário para evitar cobranças futuras. Para PaymentIntents com status=requires_capture, o valor restante capturável será automaticamente reembolsado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
payment_intent_id	string	Sim	O identificador único do PaymentIntent a cancelar.
cancellation_reason	string	Não	Motivo do cancelamento. Deve ser um dos valores: duplicate, fraudulent, requested_by_customer ou abandoned.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar intenções de pagamento

STRIPE_LIST_PAYMENT_INTENTS

Lista PaymentIntents do Stripe com filtragem opcional por cliente, data de criação ou parâmetros de paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Limite de objetos a retornar (entre 1 e 100). Padrão: 10.
customer	string	Não	Retorna apenas PaymentIntents do cliente com este ID.
created	object	Não	Filtra por data de criação usando timestamps Unix. Chaves suportadas: gt, gte, lt, lte.
ending_before	string	Não	Cursor para paginação regressiva. ID de objeto que define sua posição na lista.
starting_after	string	Não	Cursor para paginação avançada. ID de objeto que define sua posição na lista.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar cliente

STRIPE_CREATE_CUSTOMER

Cria um novo cliente no Stripe. Obrigatório para criar cobranças ou assinaturas; um e-mail é altamente recomendado para comunicações com o cliente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome completo do cliente ou nome da empresa.
email	string	Não	Endereço de e-mail principal do cliente, usado pelo Stripe para envio de faturas, recibos e outras comunicações.
phone	string	Não	Número de telefone principal do cliente. Inclua o código do país para números internacionais (ex.: +55 para o Brasil).
address	object	Não	Endereço de cobrança do cliente. Chaves comuns: line1, line2, city, state, postal_code, country (código ISO de dois dígitos, ex.: BR, US).
description	string	Não	String arbitrária para referência interna sobre o cliente (não visível para o cliente).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar cliente

STRIPE_UPDATE_CUSTOMER

Atualiza um cliente Stripe existente, identificado por customer_id, com apenas os detalhes fornecidos; campos não especificados permanecem inalterados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer_id	string	Sim	O identificador único do cliente Stripe a atualizar.
name	string	Não	Nome completo do cliente ou nome da empresa.
email	string	Não	Endereço de e-mail do cliente. Atualizar isso pode acionar um e-mail de verificação para o novo endereço.
phone	string	Não	Número de telefone principal do cliente, preferencialmente no formato E.164.
address	object	Não	Endereço de cobrança principal do cliente.
metadata	object	Não	Pares chave-valor para armazenar informações não estruturadas. Chaves até 40 caracteres, valores até 500.
description	string	Não	String arbitrária com informações adicionais sobre o cliente. Máximo de 5000 caracteres.
default_payment_method	string	Não	ID de um método de pagamento a definir como padrão do cliente para assinaturas e faturas.
balance	integer	Não	Saldo da conta do cliente na menor unidade da moeda. Valor positivo credita o saldo; negativo debita. Aplicado em faturas futuras.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar clientes

STRIPE_LIST_CUSTOMERS

Recupera uma lista de clientes Stripe com opções de filtragem por e-mail, data de criação ou relógio de teste, e suporte a paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
email	string	Não	Filtra clientes por endereço de e-mail (diferencia maiúsculas de minúsculas).
limit	integer	Não	Número máximo de objetos a retornar (entre 1 e 100). Padrão: 10.
created	object	Não	Filtra por data de criação. Use dicionário com chaves gte, lte, gt, lt e valores de timestamp Unix.
ending_before	string	Não	Cursor de paginação; recupera objetos criados antes do ID de objeto especificado.
starting_after	string	Não	Cursor de paginação; recupera objetos criados após o ID de objeto especificado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar cliente

STRIPE_RETRIEVE_CUSTOMER

Recupera informações detalhadas de um cliente Stripe existente usando seu ID único.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer_id	string	Sim	O identificador único do cliente Stripe a recuperar. Este ID normalmente começa com cus_.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar clientes

STRIPE_SEARCH_CUSTOMERS

Recupera uma lista de clientes Stripe correspondentes a uma consulta de busca usando a Linguagem de Consulta de Busca do Stripe.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	String de consulta usando a Linguagem de Consulta de Busca do Stripe. Toda consulta deve incluir pelo menos uma condição campo:valor. Operadores suportados: : para correspondência exata, ~ para correspondência de substring (mínimo 3 caracteres), operadores de comparação para campos numéricos/data. Para buscar muitos clientes, use created>0.
limit	integer	Não	Número máximo de resultados por página (padrão: 10).
page	string	Não	Cursor de paginação. DEVE ser o valor exato de next_page de uma resposta de busca anterior — NÃO um número de página numérico.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar sessão de checkout

STRIPE_CREATE_CHECKOUT_SESSION

Cria uma Sessão de Checkout do Stripe. Use quando precisar de uma URL segura e hospedada para coletar pagamentos ou assinaturas via Stripe Checkout.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
mode	string	Sim	Modo da sessão: payment (pagamento único), setup (configuração de método de pagamento) ou subscription (assinatura). O modo setup não usa line_items.
line_items	array	Sim	Lista de itens que o cliente está comprando. Cada item deve ter price (ID de Price existente) ou price_data (price inline). Necessário para modos payment e subscription.
success_url	string	Sim	URL para redirecionar clientes após pagamento ou configuração bem-sucedida.
cancel_url	string	Não	URL para redirecionar clientes se cancelarem o pagamento.
customer	string	Não	ID de cliente existente para vincular ou pré-preencher.
metadata	object	Não	Pares chave-valor para vincular à sessão.
payment_method_types	array	Não	Métodos de pagamento a aceitar (ex.: ['card', 'ideal', 'sepa_debit']). Padrão: ['card'].
allow_promotion_codes	boolean	Não	Se deve permitir códigos de promoção na sessão.
client_reference_id	string	Não	Sua referência única para a sessão.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar assinatura

STRIPE_CREATE_SUBSCRIPTION

Cria uma nova assinatura altamente configurável para um cliente Stripe existente, com suporte a múltiplos itens, períodos de teste, descontos e diversas opções de cobrança/pagamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer	string	Sim	ID do cliente Stripe existente.
items	array	Sim	Lista de itens (produtos/serviços e preços) da assinatura.
currency	string	Não	Código ISO da moeda em letras minúsculas para a assinatura.
metadata	object	Não	Pares chave-valor com informações adicionais sobre a assinatura.
trial_end	integer	Não	Timestamp Unix para o fim do período de teste. Substitui o período de teste do plano. Durante o teste, nenhum pagamento é exigido.
cancel_at	integer	Não	Timestamp Unix para agendar o cancelamento da assinatura.
description	string	Não	String arbitrária descrevendo a assinatura.
off_session	boolean	Não	Permite tentativa de pagamento inicial fora da sessão (sem interação direta do cliente).
promotion_code	string	Não	ID do código de promoção a aplicar.
days_until_due	integer	Não	Dias até o vencimento da fatura (para método de cobrança send_invoice).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Cancelar assinatura

STRIPE_CANCEL_SUBSCRIPTION

Cancela uma assinatura Stripe ativa no final do período de cobrança atual, com opções para faturar imediatamente o uso medido e calcular proporcionalmente as cobranças pelo tempo não utilizado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
subscription_id	string	Sim	Identificador da assinatura a cancelar.
prorate	boolean	Não	Se true, gera um item de fatura de proporcionalidade pelo tempo não utilizado no ciclo de cobrança atual.
invoice_now	boolean	Não	Se true, gera uma fatura final para qualquer uso medido não faturado.
cancellation_details	object	Não	Especifica os motivos do cancelamento. Chaves comuns: comment (texto livre) e feedback (ex.: customer_service, low_usage, switched_service).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar assinaturas

STRIPE_LIST_SUBSCRIPTIONS

Recupera uma lista de assinaturas Stripe, opcionalmente filtradas por vários critérios como cliente, preço, status, método de cobrança e intervalos de datas, com suporte a paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer	string	Não	ID do cliente cujas assinaturas serão recuperadas.
status	string	Não	Filtra assinaturas por status (ex.: active, all, canceled). Padrão: status não cancelados.
limit	integer	Não	Limite de objetos de assinatura a retornar (1-100). Padrão: 10.
price	string	Não	ID do preço recorrente pelo qual filtrar assinaturas.
created	object	Não	Filtra por data de criação usando chaves de comparação e valores de timestamp Unix.
collection_method	string	Não	Filtra por método de cobrança: charge_automatically ou send_invoice.
ending_before	string	Não	Cursor para paginação regressiva.
starting_after	string	Não	Cursor para paginação avançada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar assinaturas

STRIPE_SEARCH_SUBSCRIPTIONS

Busca assinaturas usando a Linguagem de Consulta de Busca do Stripe. Use quando precisar encontrar assinaturas por status, metadados, timestamp de criação ou canceled_at.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	String de consulta usando a Linguagem de Consulta de Busca do Stripe. Campos suportados para assinaturas: status, metadata, created (timestamp Unix), canceled_at (timestamp Unix). Suporta correspondências exatas, consultas de intervalo e operadores booleanos (AND, OR).
limit	integer	Não	Número máximo de resultados por página (padrão: 10, máximo: 100).
page	string	Não	Cursor de paginação. Omita na primeira requisição; use next_page da resposta anterior para páginas seguintes.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar fatura

STRIPE_CREATE_INVOICE

Cria uma nova fatura Stripe em rascunho para um cliente. Use para revisar uma fatura existente, cobrar por uma assinatura específica ou aplicar customizações detalhadas. Atenção: o Stripe impõe um valor máximo de 99.999.999 (na menor unidade da moeda) para campos de valor.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer	string	Sim	O ID do cliente a ser cobrado.
currency	string	Não	Código ISO de três letras da moeda (ex.: usd, brl). Padrão: moeda do cliente. IMPORTANTE: não pode ser usado junto com subscription.
description	string	Não	String arbitrária vinculada à fatura, frequentemente visível ao cliente.
metadata	object	Não	Pares chave-valor para armazenar informações adicionais.
due_date	integer	Não	Timestamp Unix para a data de vencimento da fatura. Deve ser uma data futura. Aplicável apenas quando collection_method=send_invoice.
auto_advance	boolean	Não	Controla se o Stripe finaliza e tenta cobrar automaticamente. Quando false, a fatura permanece como rascunho.
footer	string	Não	Texto de rodapé personalizado a exibir no PDF da fatura.
discounts	array	Não	Descontos a aplicar na fatura (IDs de cupom ou desconto).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar faturas

STRIPE_LIST_INVOICES

Recupera uma lista de faturas Stripe, filtráveis por vários critérios e com paginação usando cursores de ID de fatura obtidos de respostas anteriores.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer	string	Não	ID do cliente cujas faturas serão recuperadas.
status	string	Não	Filtra faturas por status: draft, open, paid, uncollectible ou void.
limit	integer	Não	Número máximo de objetos de fatura a retornar (1-100). Padrão: 10.
subscription	string	Não	ID da assinatura cujas faturas serão recuperadas.
created	object	Não	Filtra por data de criação. Use chaves gt, gte, lt, lte com valores de timestamp Unix.
collection_method	string	Não	Filtra por método de cobrança: charge_automatically ou send_invoice.
ending_before	string	Não	Cursor para paginação regressiva.
starting_after	string	Não	Cursor para paginação avançada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar faturas

STRIPE_SEARCH_INVOICES

Busca faturas usando a Linguagem de Consulta de Busca do Stripe. Use quando precisar encontrar faturas por status, valor total, cliente, moeda ou outros critérios. Os dados geralmente ficam pesquisáveis em até um minuto, mas a propagação pode demorar até uma hora durante interrupções.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	String de consulta usando a Linguagem de Consulta de Busca do Stripe. Campos suportados para faturas: created, currency, customer, metadata, number, status, subscription, total. Suporta correspondências exatas, consultas de intervalo e operadores booleanos (AND, OR, NOT). Não é possível misturar AND com OR na mesma consulta.
limit	integer	Não	Número máximo de resultados por página (padrão: 10).
page	string	Não	Cursor de paginação. Omita na primeira requisição; use next_page da resposta anterior para páginas seguintes.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar produto

STRIPE_CREATE_PRODUCT

Cria um novo produto no Stripe, codificando a requisição como application/x-www-form-urlencoded nivelando estruturas aninhadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do produto, exibido para os clientes.
description	string	Não	Descrição do produto, exibida aos clientes com mais detalhes.
active	boolean	Não	Indica se o produto está disponível para compra. Defina como false para arquivar.
images	array	Não	Até 8 URLs de imagem para exibição em páginas de produto ou checkout.
metadata	object	Não	Pares chave-valor para armazenar informações adicionais estruturadas.
url	string	Não	URL publicamente acessível para a página ou landing page do produto.
tax_code	string	Não	ID de código de imposto do Stripe para determinar alíquotas de imposto nas vendas.
shippable	boolean	Não	Indica se o produto é físico e requer envio.
statement_descriptor	string	Não	Texto no extrato do cartão do cliente (máximo de 22 caracteres).
default_price_data	object	Não	Dados para criar um novo objeto Price como preço padrão deste produto.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar preço

STRIPE_CREATE_PRICE

Cria um novo Price no Stripe para um produto, definindo suas cobranças (únicas ou recorrentes) e esquema de faturamento. Requer um ID de product existente ou product_data.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
currency	string	Sim	Código ISO de três letras da moeda (ex.: usd, brl). Deve ser uma moeda suportada.
product	string	Não	ID do produto para este preço. Obrigatório se product_data não for fornecido.
unit_amount	integer	Não	Valor base de cobrança na menor unidade da moeda (ex.: centavos para BRL). Obrigatório se não usar tiers, custom_unit_amount ou currency_options.
recurring	object	Não	Especifica componentes recorrentes de um preço, como intervalo de cobrança e tipo de uso.
active	boolean	Não	Se o preço pode ser usado para novas compras. Padrão: true.
metadata	object	Não	Pares chave-valor para armazenar informações adicionais sobre o preço.
nickname	string	Não	Descrição interna breve do preço, útil para distinguir preços em listagens.
tax_behavior	string	Não	Especifica como o imposto é aplicado: inclusive (incluído), exclusive (adicionado) ou unspecified.
billing_scheme	string	Não	Descreve como calcular o preço por período: per_unit (padrão) ou tiered (por faixas).
product_data	object	Não	Campos para criar um novo produto se um ID de product não for fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar reembolso

STRIPE_CREATE_REFUND

Cria um reembolso total ou parcial no Stripe, direcionado a um ID de cobrança específico ou a um ID de intenção de pagamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
charge	string	Não	Identificador da cobrança a reembolsar. Obrigatório se payment_intent não for fornecido.
payment_intent	string	Não	Identificador do PaymentIntent a reembolsar. Obrigatório se charge não for fornecido.
amount	integer	Não	Valor na menor unidade da moeda (ex.: 1000 para R$ 10,00) a reembolsar. Se omitido, um reembolso total é emitido. Não pode exceder o valor reembolsável restante da cobrança.
reason	string	Não	Motivo do reembolso: duplicate, fraudulent ou requested_by_customer.
metadata	object	Não	Pares chave-valor para vincular ao reembolso.
reverse_transfer	boolean	Não	Reverter uma transferência associada? A reversão é proporcional ao valor do reembolso.
refund_application_fee	boolean	Não	Reembolsar a taxa de aplicação? Se true, reembolsos totais reembolsam a taxa inteira; parciais reembolsam proporcionalmente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar cobrança (descontinuada)

STRIPE_CREATE_CHARGE

Cria uma cobrança direta em cartão de crédito ou débito. Atenção: este método está descontinuado; o Stripe recomenda usar a API de PaymentIntents para novas integrações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
amount	integer	Sim	Inteiro positivo representando o valor a cobrar na menor unidade da moeda (ex.: 100 centavos para R$ 1,00). Mínimo equivalente a US$ 0,50; suporta até oito dígitos.
currency	string	Sim	Código ISO de três letras da moeda, em minúsculas. Deve ser uma moeda suportada.
source	string	Não	Fonte de pagamento a cobrar (ID de cartão, conta bancária, source, token ou conta conectada).
customer	string	Não	ID de cliente existente a cobrar. Máximo de 500 caracteres.
capture	boolean	Não	Se deve capturar a cobrança imediatamente (padrão: true). Quando false, autoriza a cobrança para captura posterior.
description	string	Não	String arbitrária vinculada ao objeto Charge. Exibida na interface web e incluída em e-mails de recibo.
metadata	object	Não	Pares chave-valor para armazenar informações adicionais estruturadas.
receipt_email	string	Não	Endereço de e-mail para entrega do recibo. Máximo de 800 caracteres. Substitui o e-mail do cliente se especificado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar cobranças

STRIPE_LIST_CHARGES

Recupera uma lista de cobranças Stripe com filtragem e paginação. Use IDs de cursor válidos de respostas anteriores para paginação. As cobranças são retornadas em ordem cronológica reversa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
customer	string	Não	Filtra cobranças pelo ID de cliente especificado.
limit	integer	Não	Número máximo de cobranças a retornar (padrão: 10).
created	object	Não	Filtra cobranças por data de criação usando dicionário com chaves gt, gte, lt, lte e valores de timestamp Unix.
payment_intent	string	Não	Filtra cobranças pelo ID de PaymentIntent especificado.
ending_before	string	Não	Cursor de paginação regressiva. Use ID de cobrança de resposta anterior para buscar a página anterior.
starting_after	string	Não	Cursor de paginação avançada. Use ID de cobrança de resposta anterior para buscar a próxima página.
transfer_group	string	Não	Filtra cobranças pelo ID de grupo de transferência especificado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar saldo

STRIPE_RETRIEVE_BALANCE

Recupera os detalhes completos do saldo atual da conta Stripe conectada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.