Tools do Stripe
As 12 operações do Stripe que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Buscar clientesGETBusca clientes com a linguagem de consulta de busca do Stripe, por email, nome, telefone, data de criação ou metadata. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página. Um cliente criado ou atualizado no último minuto pode ainda não aparecer.
- Obter clienteGETRetorna um cliente, com nome, email, telefone, endereço, saldo em centavos e configurações de fatura. Um cliente excluído volta apenas com id e deleted true.
- Criar clientePOSTCria um cliente. Nenhum campo é obrigatório, mas o Stripe só envia faturas e recibos a clientes com email. Endereço, tax ids e metadata não estão disponíveis aqui.
- Atualizar clientePOSTAtualiza o nome, o email, o telefone ou a descrição de um cliente. Os campos não enviados permanecem como estão.
- Buscar cobrançasGETBusca as cobranças, que são as tentativas de pagamento com status, valor, reembolsos e disputas, com a linguagem de consulta de busca do Stripe. Os valores estão na menor unidade da moeda, como centavos. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página.
- Listar assinaturasGETLista as assinaturas, da mais nova à mais antiga, opcionalmente de um cliente, um preço ou um status. Sem status, assinaturas canceladas ficam de fora. Cada assinatura traz seus preços em items.data. Pagine com starting_after enquanto has_more for true.
- Buscar assinaturasGETBusca assinaturas por status, data de criação, data de cancelamento ou metadata com a linguagem de consulta de busca do Stripe, o que serve para perguntas como assinaturas novas ou canceladas em um período. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página.
- Atualizar assinaturaPOSTAtualiza uma assinatura, por exemplo para cancelá-la no fim do período atual com cancel_at_period_end, ou para desfazer isso. Alterar os itens ou preços da assinatura não está disponível aqui.
- Buscar faturasGETBusca faturas por cliente, assinatura, status, data, total ou número com a linguagem de consulta de busca do Stripe. Os valores estão na menor unidade da moeda, como centavos. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página.
- Criar faturaPOSTCria uma fatura em rascunho para um cliente. Adicione as linhas com Create invoice item e envie por email com Send invoice. Com collection_method send_invoice, envie days_until_due ou due_date.
- Criar item de faturaPOSTAdiciona uma linha a uma fatura em rascunho, com descrição e valor na menor unidade da moeda, como centavos. Envie amount, ou unit_amount_decimal com quantity. Sem invoice, a linha espera a próxima fatura do cliente.
- Enviar faturaPOSTFinaliza uma fatura em rascunho e a envia por email ao cliente com as instruções de pagamento. Uma fatura finalizada não pode mais mudar seus valores. Em sandbox nenhum email é enviado.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.

Conta Azul